建站
咨詢
售后
建站咨詢
新聞中心
java 怎樣給源代碼添加注釋
1、單行(single-line)--短注釋：//…… 單獨(dú)行注釋：在代碼中單起一行注釋， 注釋前最好有一行空行，并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果單行無(wú)法完成，則應(yīng)采用塊注釋。 注釋格式：/* 注釋內(nèi)容 */ 行頭注釋：在代碼行的開(kāi)頭進(jìn)行注釋。主要為了使該行代碼失去意義。 注釋格式：// 注釋內(nèi)容 行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進(jìn)行注釋。一般與代碼行后空8（至少4）個(gè)格，所有注釋必須對(duì)齊。 注釋格式：代碼 + 8（至少4）個(gè)空格 + // 注釋內(nèi)容 2、塊(block)--塊注釋：/*……*/ 注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說(shuō)明，或者算法的描述。一般位于一個(gè)文件或者一個(gè)方法的前面，起到引導(dǎo)的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會(huì)出現(xiàn)在HTML報(bào)告中。注釋格式通常寫成： /* * 注釋內(nèi)容 */ 3、文檔注釋：/**……*/ 注釋若干行，并寫入javadoc文檔。每個(gè)文檔注釋都會(huì)被置于注釋定界符 /**......*/ ...
創(chuàng)新互聯(lián)是一家專注于網(wǎng)站設(shè)計(jì)、網(wǎng)站制作與策劃設(shè)計(jì),藁城網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)做網(wǎng)站,專注于網(wǎng)站建設(shè)10年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:藁城等地區(qū)。藁城做網(wǎng)站價(jià)格咨詢:18980820575
java里已經(jīng)注釋掉的代碼該不該刪掉？
你好，很高興回答你的問(wèn)題。
注釋掉的代碼，是不會(huì)再參與到執(zhí)行中的。
刪除不刪除完全看你認(rèn)為這段代碼有沒(méi)有留著的必要，比如可能會(huì)恢復(fù)或者是可能有一定的參考價(jià)值。
如果有幫助到你，請(qǐng)點(diǎn)擊采納。
java中怎么把一整段注釋掉？怎么去掉注釋符？
選中代碼 ctrl+/ 是每一行代碼前面加注釋 //
ctrl+shift+/ 是/* */注釋
取消是同樣的操作，已有注釋的就會(huì)取消沒(méi)有就會(huì)加注釋（前提是你已經(jīng)設(shè)置了快捷鍵，我說(shuō)的這些是默認(rèn)的快捷鍵eclipse中的）
如何正確地使用Java的@deprecated 標(biāo)注
Rule #1: do Javadoc how not to
每當(dāng)你棄用某方法時(shí)，創(chuàng)建JavaDoc告訴其他程序員如何不再使用這個(gè)方法。不要只說(shuō)“這個(gè)方法廢棄了，不要用它”。因?yàn)檫@就是廢棄標(biāo)注和JavaDoc中@deprecated的字面意義，完全沒(méi)有必要再重復(fù)一遍。Java開(kāi)發(fā)人員作為目標(biāo)受眾，都知道deprecation的意思。
命名新的方法，取代舊有的。(使用@link標(biāo)注!)這可能還不夠，新的方法對(duì)應(yīng)的文檔將解釋如何使用它。不要在JavaDoc中重復(fù)（其字面意義），文檔也應(yīng)遵從DRY原則。另一方面你可能想要描述怎樣替換掉舊方法的調(diào)用，你可以就重構(gòu)的細(xì)節(jié)給出提示。
Rule #2: do not Javadoc how to
移除過(guò)時(shí)的JavaDoc文檔。有些人可能爭(zhēng)辯：維護(hù)遺留代碼的用戶可能還會(huì)需要這些文檔。事實(shí)上，他們使用的是舊版本庫(kù)中的舊版本方法。舊版本的文檔仍舊存在那里，像被刻在石頭上（更確切的說(shuō)是刻在資源倉(cāng)庫(kù)的某個(gè)版本上）。含有被廢棄掉的方法的實(shí)際版本不應(yīng)包含過(guò)時(shí)的描述文檔，那會(huì)鼓勵(lì)程序員去繼續(xù)使用。對(duì)于廢棄的方法，只有一種用法：不去用。JavaDoc應(yīng)該被實(shí)時(shí)描述，如同rule#1所述。
Rule #3: 不要在JavaDoc中解釋
不要在JavaDoc中解釋為什么方法被廢棄了。你是一個(gè)可靠的的開(kāi)發(fā)，這是你的決定，你的選擇，其他人只能忍著。如果愿意，可以寫一篇博客記錄這次調(diào)整的決策背景。這可能有幫助，但它不應(yīng)被寫在JavaDoc中。
JavaDoc的Deprecated API專用來(lái)講解如何不再使用。
重點(diǎn)是如何(how)。而不是“為什么不再使用它(why)”。
Rule #4: do deprecate
如果你覺(jué)得需要棄用一方法，那就去做吧！如果你害怕你的用戶，或不想因你廢棄掉一些方法導(dǎo)致你用戶體驗(yàn)更加痛苦，這個(gè)決定將讓你自己痛苦。盡你所能去讓API維持長(zhǎng)久的穩(wěn)定。但如果有需要被廢棄的：立刻扔掉它。不要因“為何當(dāng)初設(shè)計(jì)API時(shí)沒(méi)有考慮到未來(lái)的變動(dòng)”而感到愧疚。沒(méi)有人能完美的預(yù)見(jiàn)未來(lái)。畢竟，如果你知道未來(lái)，生活就無(wú)趣了。
java 源代碼注釋
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.*;
public class GameTest extends JFrame implements ActionListener{
/*
* 新建一個(gè)主面板(這個(gè)類可能是自定義的，本程序和API中沒(méi)有)。
*/
MainPanel j=new MainPanel();
JButton jPreview;
JLabel label;
Container container;
JPanel panel;
/**
* 主函數(shù)
* @param args
*/
public static void main(String[] args) {
//運(yùn)行程序
new GameTest();
}
/**
* 構(gòu)造函數(shù)。
*
*/
public GameTest()
{
//新建一個(gè)標(biāo)題為“拼圖”的窗口
JFrame fr =new JFrame("拼圖");
//獲取窗口容器。
container=fr.getContentPane();
//創(chuàng)建菜單條
JMenuBar jMenuBar=new JMenuBar();
//以下初始化菜單，并且設(shè)置快捷鍵和添加監(jiān)聽(tīng)器。
JMenu jMenuGame=new JMenu("游戲(G)");
jMenuGame.setMnemonic('g');
JMenuItem jMenuItemStart = new JMenuItem("開(kāi)始(S)");
jMenuItemStart.setMnemonic('s');
jMenuItemStart.addActionListener(this);
JMenuItem jMenuItemExit=new JMenuItem("退出(E)");
jMenuItemExit.setMnemonic('e');
jMenuItemExit.addActionListener(this);
jMenuGame.add(jMenuItemStart);
jMenuGame.add(jMenuItemExit);
//初始化按鈕并設(shè)置快捷鍵和添加監(jiān)聽(tīng)器
JButton jChoice=new JButton("選圖(X)");
jChoice.setMnemonic('x');
jChoice.addActionListener(this);
jPreview=new JButton("預(yù)覽(P)");
jPreview.setMnemonic('p');
jPreview.addActionListener(this);
//將菜單和按鈕添加到菜單條中
jMenuBar.add(jMenuGame);
jMenuBar.add(jChoice);
jMenuBar.add(jPreview);
//將菜單條設(shè)為該窗口的主菜單
fr.setJMenuBar(jMenuBar);
//將主面板添加到該窗口的容器中。
container.add(j);
//設(shè)置大小
fr.setSize(315,360 );
fr.setVisible(true);
//設(shè)置默認(rèn)關(guān)閉方式。
fr.setDefaultCloseOperation(3);
}
/**
* 事件處理函數(shù)。
*/
public void actionPerformed(ActionEvent e) {
if(e.getActionCommand()=="開(kāi)始(S)")
{
j.Start();
}
if(e.getActionCommand()=="預(yù)覽(P)")
{
j.setVisible(false);
panel=new JPanel();
Icon icon=new ImageIcon("pictrue/pic"+"_"+MainPanel.pictureID+".jpg");
label=new JLabel(icon);
label.setBounds(300, 300, 0, 0);
panel.add(label);
panel.setSize(300, 300);
panel.setVisible(true);
this.container.add(panel);
jPreview.setText("返回(P)");
}
if(e.getActionCommand()=="返回(P)")
{
panel.setVisible(false);
j.setVisible(true);
j.repaint();
jPreview.setText("預(yù)覽(P)");
}
if(e.getActionCommand()=="退出(E)")
{
System.exit(0);
}
if(e.getActionCommand()=="選圖(X)")
{
//初始化選擇框，并提供選擇。
Choice pic = new Choice();
pic.add("七里香");
pic.add("依然范特西");
pic.add("八度空間");
pic.add("十一月的肖邦");
pic.add("魔杰座");
pic.add("葉惠美");
pic.add("我很忙");
int i=JOptionPane.showConfirmDialog(this, pic, "選擇圖片", JOptionPane.OK_CANCEL_OPTION);
if(i==JOptionPane.YES_OPTION)
{
//選擇圖片
MainPanel.pictureID=pic.getSelectedIndex()+1;
j.removeAll();
j.reLoadPicture();
j.repaint();
}
}
}
}
java中 把一整段注釋掉 有什么方法？？ 相反的 把注釋掉的代碼前的注釋符去掉 有什么方法？？
需要一個(gè)標(biāo)識(shí)符，標(biāo)識(shí)多行注釋是否開(kāi)始
讀取一行:
（1）判斷此行內(nèi)是否包含“/＊“,如果包含，定位到“/＊“第一個(gè)字符，并標(biāo)識(shí)多行注釋開(kāi)始，繼續(xù)判斷當(dāng)前讀取行是否包含"*/"，如果包含,注釋部分刪除，其他寫回文件，未包含刪除，及以后的只判斷多行結(jié)束，直至判斷到多行注釋結(jié)束，把注釋部分刪除
（2）多行注釋未開(kāi)始，則判斷此行內(nèi)是否包含“//“,如果包含，定位到“//“第一個(gè)字符，把后面的全部刪除，注意多行注釋開(kāi)始的當(dāng)前行，還要再判斷一次“//“，因?yàn)閖ava支持以下注釋
//單行注釋/*
*多行注釋
*/
其實(shí)在代碼當(dāng)中適當(dāng)加點(diǎn)注釋，對(duì)自己、別人閱讀代碼以及以后維護(hù)都是有好處的，沒(méi)必要?jiǎng)h除全部的注釋，而且編譯會(huì)跳過(guò)注釋部分，就算你把一部武俠小說(shuō)加到代碼注釋里，也不會(huì)影響編譯出來(lái)的文件大小的
當(dāng)前標(biāo)題：java廢棄代碼注釋,java廢棄注解
網(wǎng)址分享：http://www.dlmjj.cn/article/hceocs.html
