Java和Android注釋規范


1、 文件頭注釋

每一個文件的文件頭都必須做文件頭注釋。文件頭注釋范例如下:

 
         
/*
* 文件名:LoginActivity
* 描    述:對用戶
* 作    者:
* 時    間:
* 版    權:
*/
 
         

 

 

 

                       

2、 方法頭注釋

每一個成員方法(包括自定義成員方法、覆蓋方法、屬性方法)的方法頭都必須做方法頭注釋。

自定義成員方法注釋范例如下:

/*
 * 方法名:login_Click(View v)
 * 功    能:單擊登錄按鈕的事件
 * 參    數:View v - 按鈕的View
 * 返回值:無
 */

 

 

覆蓋(重寫)成員方法注釋范例如下:

 

屬性getter和setter成員方法注釋范例如下: 

 

 

3、 塊注釋

在實現一段階段性功能的代碼前做塊注釋。塊注釋的注釋范例如下:

 

 

 

4、 變量注釋

所有的成員變量和大多數局部變量在聲明時都需要為其做功能注釋。

成員變量注釋的注釋范例如下:

 

局部變量注釋的注釋范例如下:

 

 

5、 語句注釋

在關鍵語句的右側要做單條語句注釋。

語句注釋的注釋范例如下:

 

 

6、 有關注釋的其它說明

(1)   文件頭和方法頭注釋應該使用/**/形式,變量注釋和語句注釋應該使用//形式,塊注釋應盡量使用//形式,當文字較長(單屏橫向不能顯示完全)時塊注釋也可以使用/**/形式;

(2)   注釋量必須不少於代碼總量的三分之一;

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM