java代碼頭注釋 java代碼的注釋怎么寫(xiě)
java中的注釋可分為三種類(lèi)型
Java中三種類(lèi)型的注釋?zhuān)?/p>
延慶網(wǎng)站建設(shè)公司創(chuàng)新互聯(lián),延慶網(wǎng)站設(shè)計(jì)制作，有大型網(wǎng)站制作公司豐富經(jīng)驗(yàn)。已為延慶1000+提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\外貿(mào)網(wǎng)站制作要多少錢(qián)，請(qǐng)找那個(gè)售后服務(wù)好的延慶做網(wǎng)站的公司定做！
單行注釋?zhuān)?/ 注釋內(nèi)容
多行注釋?zhuān)?*... 注釋內(nèi)容....*/
文本注釋?zhuān)?**.. 注釋內(nèi)容....*/
代碼注釋是架起程序設(shè)計(jì)者與程序閱讀者之間的通信橋梁，最大限度的提高團(tuán)隊(duì)開(kāi)發(fā)合作效率。也是程序代碼可維護(hù)性的重要環(huán)節(jié)之一。所以不是為寫(xiě)注釋而寫(xiě)注釋。
備注：簡(jiǎn)單的代碼做簡(jiǎn)單注釋?zhuān)⑨寖?nèi)容不大于10個(gè)字即可，另外，持久化對(duì)象或VO對(duì)象的getter、setter方法不需加注釋。
擴(kuò)展資料：
類(lèi)（模塊）注釋采用 /** …… */，在每個(gè)類(lèi)（模塊）的頭部要有必要的注釋信息，包括：工程名；類(lèi)（模塊）編號(hào)；命名空間；類(lèi)可以運(yùn)行的JDK版本；版本號(hào)；作者；創(chuàng)建時(shí)間；類(lèi)（模塊）功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該類(lèi)與其類(lèi)的關(guān)系等，必要時(shí)還要有一些如特別的軟硬件要求等說(shuō)明）；主要函數(shù)或過(guò)程清單及本類(lèi)（模塊）歷史修改記錄等。
參考資料來(lái)源：百度百科-java注釋
如何寫(xiě)好java代碼注釋
寫(xiě)代碼的時(shí)候，有時(shí)候，你需要寫(xiě)一些注釋?zhuān)褍?nèi)容相互關(guān)聯(lián)起來(lái)，方便自己或別人看的時(shí)候，可以直接找到你關(guān)聯(lián)的代碼類(lèi)或者啥的。
這個(gè)時(shí)候，{@link}與@see，這2個(gè)javadoc注解就派上用場(chǎng)了，
不管他具體有什么功能，咱就只管一個(gè)，他可以鏈接代碼，讓注釋看的更清楚易懂。方便你我他。
@see 標(biāo)簽允許用戶(hù)引用其他類(lèi)的文檔。具體使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名稱(chēng)
@see fully-qualified-classname#屬性名稱(chēng)
我在使用的時(shí)候，發(fā)現(xiàn)這個(gè)只能單獨(dú)一行頂頭寫(xiě)，如果不頂頭寫(xiě)就不管用了，沒(méi)了鏈接的效果。
但是，{@link}這個(gè)卻可以隨便放。
具體使用方法和上面那個(gè)@see是一樣的。
實(shí)際效果，看下面的圖
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è)類(lèi)可能是自定義的，本程序和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 怎樣給源代碼添加注釋
1、單行(single-line)--短注釋?zhuān)?/……
單獨(dú)行注釋?zhuān)涸诖a中單起一行注釋?zhuān)?/p>
注釋前最好有一行空行，并與其后的代碼具有一樣的縮進(jìn)層級(jí)。如果單行無(wú)法完成，則應(yīng)采用塊注釋。
注釋格式：/*
注釋內(nèi)容
*/
行頭注釋?zhuān)涸诖a行的開(kāi)頭進(jìn)行注釋。主要為了使該行代碼失去意義。
注釋格式：//
注釋內(nèi)容
行尾注釋?zhuān)何捕?trailing)--極短的注釋?zhuān)诖a行的行尾進(jìn)行注釋。一般與代碼行后空8（至少4）個(gè)格，所有注釋必須對(duì)齊。
注釋格式：代碼
+
8（至少4）個(gè)空格
+
//
注釋內(nèi)容
2、塊(block)--塊注釋?zhuān)?*……*/
注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結(jié)構(gòu)等的意義與用途的說(shuō)明，或者算法的描述。一般位于一個(gè)文件或者一個(gè)方法的前面，起到引導(dǎo)的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會(huì)出現(xiàn)在HTML報(bào)告中。注釋格式通常寫(xiě)成：
/*
*
注釋內(nèi)容
*/
3、文檔注釋?zhuān)?**……*/
注釋若干行，并寫(xiě)入javadoc文檔。每個(gè)文檔注釋都會(huì)被置于注釋定界符
/**......*/
...
本文題目：java代碼頭注釋 java代碼的注釋怎么寫(xiě)
URL地址：http://m.jiaotiyi.com/article/ddeooec.html