如何在java程序中添加注釋

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

成都創(chuàng)新互聯(lián)公司公司2013年成立，先為陵水黎族等服務(wù)建站，陵水黎族等地企業(yè)，進行企業(yè)商務(wù)咨詢服務(wù)。為陵水黎族企業(yè)網(wǎng)站制作PC+手機+微官網(wǎng)三網(wǎng)同步一站式服務(wù)解決您的所有建站問題。

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

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

java中的注釋可分為三種類型

Java中三種類型的注釋：

單行注釋：// 注釋內(nèi)容

多行注釋：/*... 注釋內(nèi)容....*/

文本注釋：/**.. 注釋內(nèi)容....*/

代碼注釋是架起程序設(shè)計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發(fā)合作效率。也是程序代碼可維護性的重要環(huán)節(jié)之一。所以不是為寫注釋而寫注釋。

備注：簡單的代碼做簡單注釋，注釋內(nèi)容不大于10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加注釋。

擴展資料：

類（模塊）注釋采用 /** …… */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創(chuàng)建時間；類（模塊）功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該類與其類的關(guān)系等，必要時還要有一些如特別的軟硬件要求等說明）；主要函數(shù)或過程清單及本類（模塊）歷史修改記錄等。

參考資料來源：百度百科-java注釋

java 文檔注釋是注釋什么的,不是有多行注釋了嗎?

1、【文檔注釋】是寫在類或者方法的上面的。

文檔注釋可以用eclipse導(dǎo)出chm格式的幫助文檔，拿給其他人用時，方便他人理解。文檔注釋被調(diào)用的方法，當鼠標移到上面時提醒注釋內(nèi)容。

使用文檔注釋時，需要在開始的?/**?之后，第一行或幾行是關(guān)于類、變量和方法的主要描述。

之后，可以包含一個或多個何種各樣的@?標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應(yīng)該放成一組。

2、【多行注釋】注釋的也是方法或類，言下之意就是一次性的將程序中的多行代碼注釋掉，但多行注釋的內(nèi)容不能用于生成一個開發(fā)者文檔。

3、【多行注釋與文檔注釋的區(qū)別】多行注釋的內(nèi)容不能用于生成一個開發(fā)者文檔，而文檔注釋的內(nèi)容可以生產(chǎn)一個開發(fā)者文檔。

擴展資料

java常用的文檔注釋標簽

1、@author：標識一個類的作者

實例：?@authordescription

2、@deprecated：指名一個過期的類或成員

實例：?@deprecateddescription

3、@exception：標志一個類拋出的異常

實例：@exceptionexception-nameexplanation

4、{@inheritDoc}：從直接父類繼承的注釋

實例：Inheritsacommentfromtheimmediatesurperclass.

5、{@link}：插入一個到另一個主題的鏈接

實例：{@linknametext}

6、{@linkplain}：插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體

實例：Insertsanin-linelinktoanothertopic.

7、@param：說明一個方法的參數(shù)

實例：@paramparameter-nameexplanation

8、@return：說明返回值類型

實例：@returnexplanation

9、@see：指定一個到另一個主題的鏈接

實例：@seeanchor

10、@serial：說明一個序列化屬性

實例：@serialdescription

參考資料：百度百科-java注釋

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

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

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

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