如何寫好java代碼注釋

寫代碼的時候，有時候，你需要寫一些注釋，把內(nèi)容相互關(guān)聯(lián)起來，方便自己或別人看的時候，可以直接找到你關(guān)聯(lián)的代碼類或者啥的。

創(chuàng)新互聯(lián)公司是一家專注于成都網(wǎng)站制作、成都做網(wǎng)站與策劃設計,山城網(wǎng)站建設哪家好?創(chuàng)新互聯(lián)公司做網(wǎng)站,專注于網(wǎng)站建設十載,網(wǎng)設計領域的專業(yè)建站公司;建站業(yè)務涵蓋:山城等地區(qū)。山城做網(wǎng)站價格咨詢:18982081108

這個時候，{@link}與@see，這2個javadoc注解就派上用場了，

不管他具體有什么功能，咱就只管一個，他可以鏈接代碼，讓注釋看的更清楚易懂。方便你我他。

@see 標簽允許用戶引用其他類的文檔。具體使用方式如下：

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名稱

@see fully-qualified-classname#屬性名稱

我在使用的時候，發(fā)現(xiàn)這個只能單獨一行頂頭寫，如果不頂頭寫就不管用了，沒了鏈接的效果。

但是，{@link}這個卻可以隨便放。

具體使用方法和上面那個@see是一樣的。

實際效果，看下面的圖

JAVA游戲代碼注釋

import javax.swing.*;import java.awt.*;import java.awt.event.*;public class lianliankan implements ActionListener{JFrame mainFrame; //主面板Container thisContainer;JPanel centerPanel,southPanel,northPanel; //子面板JButton diamondsButton[][] = new JButton[6][5];//游戲按鈕數(shù)組JButton exitButton,resetButton,newlyButton; //退出，重列，重新開始按鈕JLabel fractionLable=new JLabel("0"); //分數(shù)標簽JButton firstButton,secondButton; //分別記錄兩次被選中的按鈕int grid[][] = new int[8][7];//儲存游戲按鈕位置static boolean pressInformation=false; //判斷是否有按鈕被選中int x0=0,y0=0,x=0,y=0,fristMsg=0,secondMsg=0,validateLV; //游戲按鈕的位置坐標int i,j,k,n;//消除方法控制public void init(){mainFrame=new JFrame("JKJ連連看");thisContainer = mainFrame.getContentPane();thisContainer.setLayout(new BorderLayout());centerPanel=new JPanel();southPanel=new JPanel();northPanel=new JPanel();thisContainer.add(centerPanel,"Center");thisContainer.add(southPanel,"South");thisContainer.add(northPanel,"North");centerPanel.setLayout(new GridLayout(6,5));for(int cols = 0;cols 6;cols++){for(int rows = 0;rows 5;rows++ ){diamondsButton[cols][rows]=new JButton(String.valueOf(grid[cols+1][rows+1]));diamondsButton[cols][rows].addActionListener((java.awt.event.ActionListener) this);centerPanel.add(diamondsButton[cols][rows]);}}exitButton=new JButton("退出");exitButton.addActionListener((java.awt.event.ActionListener) this);resetButton=new JButton("重列");resetButton.addActionListener((java.awt.event.ActionListener) this);newlyButton=new JButton("再來一局");newlyButton.addActionListener((java.awt.event.ActionListener) this);southPanel.add(exitButton);southPanel.add(resetButton);southPanel.add(newlyButton);fractionLable.setText(String.valueOf(Integer.parseInt(fractionLable.getText())));northPanel.add(fractionLable);mainFrame.setBounds(280,100,500,450);mainFrame.setVisible(true);}public void randomBuild() {int randoms,cols,rows;for(int twins=1;twins=15;twins++) {randoms=(int)(Math.random()*25+1);for(int alike=1;alike=2;alike++) {cols=(int)(Math.random()*6+1);rows=(int)(Math.random()*5+1);while(grid[cols][rows]!=0) {cols=(int)(Math.random()*6+1);rows=(int)(Math.random()*5+1);}this.grid[cols][rows]=randoms;}}}public void fraction(){fractionLable.setText(String.valueOf(Integer.parseInt(fractionLable.getText())+100));}public void reload() {int save[] = new int[30];int n=0,cols,rows;int grid[][]= new int[8][7];for(int i=0;i=6;i++) {for(int j=0;j=5;j++) {if(this.grid[i][j]!=0) {save[n]=this.grid[i][j];n++;}}}n=n-1;this.grid=grid;while(n=0) {cols=(int)(Math.random()*6+1);rows=(int)(Math.random()*5+1);while(grid[cols][rows]!=0) {cols=(int)(Math.random()*6+1);rows=(int)(Math.random()*5+1);}this.grid[cols][rows]=save[n];n--;}mainFrame.setVisible(false);pressInformation=false; //這里一定要將按鈕點擊信息歸為初始init();for(int i = 0;i 6;i++){for(int j = 0;j 5;j++ ){if(grid[i+1][j+1]==0)diamondsButton[i][j].setVisible(false);}}}public void estimateEven(int placeX,int placeY,JButton bz) {if(pressInformation==false) {x=placeX;y=placeY;secondMsg=grid[x][y];secondButton=bz;pressInformation=true;}else {x0=x;y0=y;fristMsg=secondMsg;firstButton=secondButton;x=placeX;y=placeY;secondMsg=grid[x][y];secondButton=bz;if(fristMsg==secondMsg secondButton!=firstButton){xiao();}}}public void xiao() { //相同的情況下能不能消去。仔細分析，不一條條注釋if((x0==x (y0==y+1||y0==y-1)) || ((x0==x+1||x0==x-1)(y0==y))){ //判斷是否相鄰remove();}else{for (j=0;j7;j++ ) {if (grid[x0][j]==0){ //判斷第一個按鈕同行哪個按鈕為空if (yj) { //如果第二個按鈕的Y坐標大于空按鈕的Y坐標說明第一按鈕在第二按鈕左邊f(xié)or (i=y-1;i=j;i-- ){ //判斷第二按鈕左側(cè)直到第一按鈕中間有沒有按鈕if (grid[x][i]!=0) {k=0;break;}else{ k=1; } //K=1說明通過了第一次驗證}if (k==1) {linePassOne();}}if (yj){ //如果第二個按鈕的Y坐標小于空按鈕的Y坐標說明第一按鈕在第二按鈕右邊f(xié)or (i=y+1;i=j ;i++ ){ //判斷第二按鈕左側(cè)直到第一按鈕中間有沒有按鈕if (grid[x][i]!=0){k=0;break;}else { k=1; }}if (k==1){linePassOne();}}if (y==j ) {linePassOne();}}if (k==2) {if (x0==x) {remove();}if (x0x) {for (n=x0;n=x-1;n++ ) {if (grid[n][j]!=0) {k=0;break;}if(grid[n][j]==0 n==x-1) {remove();}}}if (x0x) {for (n=x0;n=x+1 ;n-- ) {if (grid[n][j]!=0) {k=0;break;}if(grid[n][j]==0 n==x+1) {remove();}}}}}for (i=0;i8;i++ ) { //列if (grid[i][y0]==0) {if (xi) {for (j=x-1;j=i ;j-- ) {if (grid[j][y]!=0) {k=0;break;}else { k=1; }}if (k==1) {rowPassOne();}}if (xi) {for (j=x+1;j=i;j++ ) {if (grid[j][y]!=0) {k=0;break;}else { k=1; }}if (k==1) {rowPassOne();}}if (x==i) {rowPassOne();}}if (k==2){if (y0==y) {remove();}if (y0y) {for (n=y0;n=y-1 ;n++ ) {if (grid[i][n]!=0) {k=0;break;}if(grid[i][n]==0 n==y-1) {remove();}}}if (y0y) {for (n=y0;n=y+1 ;n--) {if (grid[i][n]!=0) {k=0;break;}if(grid[i][n]==0 n==y+1) {remove();}}}}}}}public void linePassOne(){if (y0j){ //第一按鈕同行空按鈕在左邊f(xié)or (i=y0-1;i=j ;i-- ){ //判斷第一按鈕同左側(cè)空按鈕之間有沒按鈕if (grid[x0][i]!=0) {k=0;break;}else { k=2; } //K=2說明通過了第二次驗證}}if (y0j){ //第一按鈕同行空按鈕在與第二按鈕之間for (i=y0+1;i=j ;i++){if (grid[x0][i]!=0) {k=0;break;}else{ k=2; }}}}public void rowPassOne(){if (x0i) {for (j=x0-1;j=i ;j-- ) {if (grid[j][y0]!=0) {k=0;break;}else { k=2; }}}if (x0i) {for (j=x0+1;j=i ;j++ ) {if (grid[j][y0]!=0) {k=0;break;}else { k=2; }}}}public void remove(){firstButton.setVisible(false);secondButton.setVisible(false);fraction();pressInformation=false;k=0;grid[x0][y0]=0;grid[x][y]=0;}public void actionPerformed(ActionEvent e) {if(e.getSource()==newlyButton){int grid[][] = new int[8][7];this.grid = grid;randomBuild();mainFrame.setVisible(false);pressInformation=false;init();}if(e.getSource()==exitButton)System.exit(0);if(e.getSource()==resetButton)reload();for(int cols = 0;cols 6;cols++){for(int rows = 0;rows 5;rows++ ){if(e.getSource()==diamondsButton[cols][rows])estimateEven(cols+1,rows+1,diamondsButton[cols][rows]);}}}public static void main(String[] args) {lianliankan llk = new lianliankan();llk.randomBuild();llk.init();}}

請采納。

java代碼注釋(所有代碼)注釋比較重點的也行

多注了些控制流程，希望我的注釋能夠?qū)δ阌袔椭?/p>

import java.awt.*;

import java.awt.event.*;

import javax.swing.*;

public class GoodLucky extends JFrame implements ActionListener{

JTextField tf = new JTextField(); //實例化一個文本域

//設置兩個按鈕

JButton b1 = new JButton("開始");

JButton b2 = new JButton("停止");

boolean isGo = false;

//構(gòu)造函數(shù)

public GoodLucky(){

b1.setActionCommand("start");//在開始按鈕上設置一個動作監(jiān)聽 start

JPanel p = new JPanel(); //實例化一個可視化容器

//將兩個按鈕添加到可視化容器上面，用add方法

p.add(b1);

p.add(b2);

//在兩個按鈕上增加監(jiān)聽的屬性,自動調(diào)用下面的監(jiān)聽處理方法actionPerformed(ActionEvent e)，如果要代碼有更好的可讀性，可用內(nèi)部類實現(xiàn)動作

//監(jiān)聽處理。

b1.addActionListener(this);

b2.addActionListener(this);

//將停止按鈕設置為不可編輯（即不可按的狀態(tài)）

b2.setEnabled(false);

this.getContentPane().add(tf,"North"); //將上面的文本域放在面板的北方，也就是上面（上北下南左西右東）

this.getContentPane().add(p,"South"); //將可視化容器pannel放在南邊，也就是下面

this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); //設置用戶在此窗體上發(fā)起 "close" 時默認執(zhí)行的操作，參數(shù)EXIT_ON_CLOSE是使用 System exit 方法退出應用程序。僅在應用程序中使用

this.setSize(300,200); //設置面板大小，寬和高

this.setLocation(300,300); //設置面板剛開始的出現(xiàn)的位置

Cursor cu = new Cursor(Cursor.HAND_CURSOR); //用指定名稱創(chuàng)建一個新的定制光標對象，參數(shù)表示手狀光標類型

this.setCursor(cu); //為指定的光標設置光標圖像，即設置光標圖像為上面所創(chuàng)建的手狀光標類型

this.setVisible(true); //將面板可視化設置為true，即可視，如果為false，即程序運行時面板會隱藏

tf.setText("welcome you! "); //設置面板的標題為歡迎

this.go(); //調(diào)用go方法

}

public void go(){

while(true){ //這里是死循環(huán)，也就是說用戶不點擊停止按鈕的話他一直循環(huán)出現(xiàn)隨機數(shù)，直到用戶點擊停止按鈕循環(huán)才能推出，具體流程在actionPerformed方法中控制。

if(isGo == true){ //上面所定義的isGo的初始值為false，所以程序第一次到此會跳過

String s = ""; //設置空字符串

for(int j = 1; j = 7;j++){ //產(chǎn)生7個隨機數(shù)

int i = (int)(Math.random() * 36) + 1;//每個隨機數(shù)產(chǎn)生方式，這里定義靈活，可以自由定義隨機數(shù)產(chǎn)生的方式

if(i 10){

s = s + " 0" + i; //如果產(chǎn)生的隨機數(shù)小于10的話做處理：這里就牽扯到一個重要的概念，簡單敘述一下：

/*

當一個字符串與一個整型數(shù)項相加的意思是連接，上面的s = s + " 0" + i的意思是字符串s鏈接0再連接整型i值，而不會導致0和整型的i相加，

產(chǎn)生的效果為s0i,由于s為空字符串（上面定義過的），所以當i小于零時，在個位數(shù)前面加上0，比如產(chǎn)生的隨機數(shù)i為7的話，顯示效果為 07.

*/

}else{

s = s + " " + i; //如果產(chǎn)生的隨機數(shù)比10打的話，那么加上空格顯示，即數(shù)字和數(shù)字之間有個空格

}

//以上循環(huán)循環(huán)七次，以保證能出現(xiàn)7個隨機數(shù)

}

tf.setText(s); //將產(chǎn)生的隨機數(shù)全部顯示在文本域上，用文本域?qū)ο髏f調(diào)用它的設置文本的方法setText(String)實現(xiàn)。

}

//以下為線程延遲

try{

Thread.sleep(10); //線程類同步方法sleep，睡眠方法，括號里的單位為ms。

}catch(java.lang.InterruptedException e){

e.printStackTrace(); //異常捕獲，不用多說。

}

}

}

//以下是上面設置的事件監(jiān)聽的具體處理辦法，即監(jiān)聽時間處理方法，自動調(diào)用

public void actionPerformed(ActionEvent e){ //傳入一個動作事件的參數(shù)e

String s = e.getActionCommand(); //設置字符串s來存儲獲得動作監(jiān)聽，上面的start

/*

以下這個條件語句塊的作用為：用戶點擊開始后（捕獲start，用方法getActionCommand()），將命令觸發(fā)設置為true，從而執(zhí)行上面的go方法中的循環(huán)體（因為循環(huán)體中要求isGo參數(shù)為true,而初始為false）。

執(zhí)行循環(huán)快產(chǎn)生隨機數(shù)，并將開始按鈕不可編輯化，而用戶只可以使用停止按鈕去停止。如果用戶按下停止時，也就是沒有傳入?yún)?shù)“start”的時候，

執(zhí)行else語句塊中的語句，isGo設置為false，將不執(zhí)行上面go中的循環(huán)語句塊，從而停止產(chǎn)生隨機數(shù)，并顯示，并且把開始按鈕設置為可用，而把

停止按鈕設置為不可用，等待用戶按下開始再去開始新一輪循環(huán)產(chǎn)生隨機數(shù)。

*/

if(s.equals("start")){ //如果捕獲到start，也就是用戶觸發(fā)了動作監(jiān)聽器，那么下面處理

isGo = true; //設置isGo為true

b1.setEnabled(false); //將開始按鈕設置為不可用

b2.setEnabled(true); //將停止按鈕設置為可用

}else{

isGo = false; //將isGo設置為false，isGo為循環(huán)標志位

b2.setEnabled(false); //設置停止按鈕為不可用（注意看是b2,b2是停止按鈕）

b1.setEnabled(true); //設置開始按鈕為可用

}

}

public static void main(String[] args){

new GoodLucky(); //產(chǎn)生類的實例，執(zhí)行方法

}

}

圣誕平安夜了，祝朋友開心快樂！

求一個50行左右的JAVA代碼，最好每行帶注釋，謝謝啦

/*這個相當詳細了.

程序也不算太難.而且給老師看的時候效果比較好.因為有圖形化界面,又實現(xiàn)一個比較實用的功能.老師會比較高興的.

建立一個文件名為Change.java就可以編譯了*/

/*

* 這個程序?qū)崿F(xiàn)輸入身高算出標準體重,輸入體重,算出身高的功能

*/

import java.awt.*; //導入相關(guān)類包,這才樣使用相應awt圖形界面的類

import java.awt.event.*;//同上

public class Change extends Frame { //定義一個類Change, 父類是Frame(圖形界面的)

Button b = new Button("互查"); //創(chuàng)建一個按鈕的對象b,顯示為"互查"

Label l1 = new Label("身高(cm)");//創(chuàng)建一個lable.顯示身高

Label l2 = new Label("體重(kg)");//創(chuàng)建一個lable 顯示體重

double heigth, weigth; //定義變量

double x, y; //定義變量

TextField tf1 = new TextField(null, 10);//添加Text框

TextField tf2 = new TextField(null, 10);//添加Text框

public Change() {//類的構(gòu)造函數(shù),完成初始化

super("互查表");//創(chuàng)建窗口,標題為互查表

setLayout(new FlowLayout(FlowLayout.LEFT));//設置布局

add(l1);//把lable 身高放到window里

add(tf1);//把Text 框 放到窗口上

add(l2); //把lable 體重放到window里

add(tf2);//Test放到窗口里

add(b);//把button放到窗口上

pack();//自動放到窗口里排列上邊的組件

setVisible(true);//可以讓用戶看到窗口

addWindowListener(new WindowAdapter() {//如果按 X, 關(guān)閉窗口

public void windowClosing(WindowEvent e) {

System.exit(0);

}

});

b.addActionListener(new ButtonListener());//添加button監(jiān)聽函數(shù)

}

class ButtonListener implements ActionListener {//實現(xiàn)click button時功能操作

public void actionPerformed(ActionEvent e) {//當click調(diào)用

if (tf1.getText()!=null) {//檢查tf1 test 是否為空

try {//取異常

x = Double.parseDouble(tf1.getText());//字符轉(zhuǎn)為double型

weigth = (x - 100) * 0.9;//算重量

tf2.setText("" + weigth);//顯示重量

} catch (NumberFormatException ex) {

tf1.setText("");//如果輸入不是數(shù)字,設為空

}

}

if (tf1.getText().equals("")==true){//tf1是否為空

y = Double.parseDouble(tf2.getText());//把tf2里的文本轉(zhuǎn)為double 型 的

heigth = y / 0.9 + 100; //算身高根據(jù)重量

tf1.setText("" + heigth);}//顯示身高

}

}

public static void main(String[] args) {//主函數(shù),程序入口

new Change(); //建立類Change的對象,并調(diào)用他的構(gòu)造函數(shù)Change().顯示窗口

}

}