Java注釋有三種方式
代碼是寫給人看的烈拒,寫注釋是為了能讓人快速看懂代碼段磨,方便程序員間的交流。代碼要有規(guī)范蜓竹,要有良好的風(fēng)格箕母,要有很好的可讀性,合理的注釋是提高代碼可讀性的方法之一俱济。
單行注釋 //
以 //
開頭, //
后面的內(nèi)容都會(huì)被認(rèn)為是注釋嘶是。
示例:
//年齡
//性別
//愛好
多行注釋 /**/
以 /*
開頭,以 */
結(jié)束, /*
和 */
之間的的內(nèi)容都會(huì)被認(rèn)為是注釋。
多行注釋用于說(shuō)明比較復(fù)雜的內(nèi)容蛛碌,如復(fù)雜的邏輯或者算法聂喇。
示例:
/*
* 年齡
* 性別
* 愛好
*/
文檔注釋 /***/
以 /**
開頭,以*/
結(jié)束, /**
和 */
之間的的內(nèi)容都會(huì)被認(rèn)為是注釋。
示例:
/**
* 學(xué)生類
* @author Jason
* @version 2.0
*/
文檔注釋可以提取出來(lái)蔚携,生成像官方API幫助文檔風(fēng)格一樣的文檔希太。
使用JDK提供的javadoc
命令,可以自動(dòng)生成一份HTML格式的文檔酝蜒,風(fēng)格和官方API幫助文檔一樣誊辉。
使用javadoc
命令提取文檔:
javadoc -d doc -encoding UTF-8 -charset UTF-8 xxx.java
這條命令的意思就是把xxx.java中的文檔注釋提取出來(lái),生成的幫助文檔放在doc文件夾下亡脑,其編碼格式為UTF-8堕澄。