java代碼注釋怎么做 java代碼注釋怎么做的

為什么要為程序添加注釋，在java程序中如何為程序添加注釋？

注釋是用來給開發(fā)者或者是軟件后續(xù)的維護者來看的。一般是用來描述這一段代碼或者是程序做了些什么樣的事情。實現了哪些功能，java里面注釋代碼，可以分為行注釋和塊注釋，方法注釋等。

我們提供的服務有：網站設計制作、做網站、微信公眾號開發(fā)、網站優(yōu)化、網站認證、商城ssl等。為1000+企事業(yè)單位解決了網站和推廣的問題。提供周到的售前咨詢和貼心的售后服務，是有科學管理、有技術的商城網站制作公司

行注釋就是在需要注釋的代碼前加 //

塊注釋則是用 /* 和 */ 把文本段落框起來即可

如何寫好java代碼注釋

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

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

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

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

@see classname

@see fully-qualified-classname

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

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

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

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

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

實際效果，看下面的圖

如何在java程序中添加注釋

1、單行(single-line)--短注釋：//…… 單獨行注釋：在代碼中單起一行注釋， 注釋前最好有一行空行，并與其后的代碼具有一樣的縮進層級。如果單行無法完成，則應采用塊注釋。 注釋格式：/* 注釋內容 */ 行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。 注釋格式：// 注釋內容 行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進行注釋。一般與代碼行后空8（至少4）個格，所有注釋必須對齊。 注釋格式：代碼 + 8（至少4）個空格 + // 注釋內容

2、塊(block)--塊注釋：/*……*/ 注釋若干行，通常用于提供文件、方法、數據結構等的意義與用途的說明，或者算法的描述。一般位于一個文件或者一個方法的前面，起到引導的作用，也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成： /* * 注釋內容 */

3、文檔注釋：/**……*/ 注釋若干行，并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符 /**......*/ ...

給Java代碼的的每一句做一個注釋，很簡單的

package?com.test;//最好有包，包名可自定義

import?java.awt.*;//導入java.awt包下所有的類

import?java.awt.event.*;//導入java.awt.event包下所以的類

import?javax.swing.*;//導入javax.swing包下所有的類

public?class?Test?extends?JFrame?{

private?JPanel?panel;

private?JLabel?one,?equ,?result,?img,?end;

private?JTextField?input;

private?JButton?check;

private?int?first,?second;

public?Test()?{

super("小程序查看器");//?調用JFrame的構造方法，名字是“小程序查看器”

one?=?new?JLabel("小程序");//?創(chuàng)建名稱為“小程序”的JLabel標簽

one.setFont(new?Font("宋體",?Font.PLAIN,?15));//?設置JLabel控件的字體參數

makeRandom();//?生成隨機數

equ?=?new?JLabel(first?+?"+"?+?second?+?"=");//?創(chuàng)建算式

input?=?new?JTextField(10);//?創(chuàng)建寬度是10的文字輸入框

check?=?new?JButton("檢查");//?創(chuàng)建檢查按鈕

check.addActionListener(new?ActionListener()?{//?給檢查按鈕添加事件監(jiān)聽器

public?void?actionPerformed(ActionEvent?e)?{

int?r?=?Integer.parseInt(input.getText());//?獲取輸入的數字

if?(first?+?second?==?r)?{//?判斷結果?正確則顯示

result.setText("you?are?right!");

}?else?{//?算錯則顯示

result.setText("you?are?wrong!");

}

}

});

result?=?new?JLabel();//?創(chuàng)建一個新的結果標簽，賦值給result變量

img?=?new?JLabel(new?ImageIcon("1.jpg"));//?創(chuàng)建一個帶圖片的標簽

panel?=?new?JPanel(new?FlowLayout(FlowLayout.CENTER,?5,?5));//?創(chuàng)建新的面板，組件對齊方式為居中，水平和垂直間距為5

panel.add(equ);//?添加算式到面板中

panel.add(input);//?添加文字輸入框到面板中

panel.add(check);//?添加檢查按鈕到面板中

panel.add(result);//?添加結果到面板中

panel.add(img);//?添加圖片

end?=?new?JLabel("小程序已啟動。");//?新標簽“小程序已經啟動”

end.setFont(new?Font("宋體",?Font.PLAIN,?15));//?字體為宋體，普通格式，字號為15

end.setOpaque(true);//?透明效果

end.setBackground(Color.WHITE);//?背景白色

getContentPane().add(one,?BorderLayout.NORTH);//?在上面添加小程序標簽

getContentPane().add(panel,?BorderLayout.CENTER);//?在中間添加panel

getContentPane().add(end,?BorderLayout.SOUTH);//?在下面添加結束標簽

setSize(300,?300);//?設置顯示大小為300*300

setLocationRelativeTo(null);//?不偏移

setDefaultCloseOperation(3);//?默認關閉操作，點擊關閉時候退出

setVisible(true);//?設置可見狀態(tài)

}

/**

*?此方法描述的是：獲取隨機數

*/

public?void?makeRandom()?{

first?=?(int)?(Math.random()?*?100?+?1);

second?=?(int)?(Math.random()?*?100?+?1);

}

/**

*?此方法描述的是：程序的主入口?main方法

*/

public?static?void?main(String[]?args)?{

new?Test();//?創(chuàng)建新的實例，調用無參數的構造方法

}

}

標題名稱：java代碼注釋怎么做 java代碼注釋怎么做的
標題鏈接：http://bm7419.com/article18/ddcchgp.html

成都網站建設公司_創(chuàng)新互聯(lián)，為您提供網站排名、網站收錄、網站改版、動態(tài)網站、面包屑導航、服務器托管

廣告

聲明：本網站發(fā)布的內容（圖片、視頻和文字）以用戶投稿、用戶轉載內容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內容未經允許不得轉載，或轉載時需注明來源： 創(chuàng)新互聯(lián)