注釋本身並沒有什么好說的,無非就是三種注釋,使用情況分別如下:
1、三種注釋方式
1.單行注釋(single-line)://注釋內容
一次只能注釋一行,一般是簡單注釋,用來簡短描述某個變量或屬性,程序塊。
2.塊注釋(block):/*注釋內容*/
為了進行多行簡單注釋,一般不使用。
3.文檔注釋:/**注釋內容 */
可以使用多行,一般用來對類、接口、成員方法、成員變量、靜態字段、靜態方法、常量進行說明。Javadoc可以用它來產生代碼的文檔。為了可讀性,可以有縮進和格式控制。
文檔注釋常采用一些Javadoc標簽進行文檔的特定用途描述,用於幫助Javadoc產生文檔.
2.注釋的內容
實驗室一群菜雞(包括我)寫了一個項目,注釋簡直慘不忍睹,舉個例子。
1. 幾乎每個return上面都有一個
// 返回數值
恕我愚鈍,我到現在還是沒看懂這個注釋的意思,當然不是說不理解他的意思,而是他的意義何在???
我覺得寫代碼的人應該都認識 return 吧。。。。
2. 特別喜歡當翻譯。比如我們項目下有這樣一條注釋。
* @Title: getWeighs 獲取稱信息
外日,這些英文我懂,為了生成文檔,但是這個中文,我就見了鬼了,即使是離代碼最遠的文檔中我覺得這句話也好廢物。
我覺得我應該認識 get 和 Weigh (即使不認識,也可以一秒百度),所以這句翻譯的意義究竟在哪里??
3. 該注釋的一句話都沒寫。
BaseUtil.initInfo(info, "startDatetime",startDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")), "endDatetime",
endDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")));
這么長的一段代碼明顯可以拆分成多個,但是寧願別人浪費點時間去理解,也不願意浪費空間去讓其變簡單。
改一下:
String stratDtStr = startDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")); String endDtStr = endDatetime.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")); BaseUtil.initInfo(info, "startDatetime",stratDtStr, "endDatetime",endDtStr);
明顯更容易讓讀這段代碼的人理解。。
當然我們在項目開發的時候需要調用他人提供的接口,於是"不得不"讓一句代碼很很佷長,比如下面這個情況。