Java和Android注釋規範

標籤：

轉自：http://www.cnblogs.com/SharkBin/p/3999804.html

1、 檔案頭注釋

每一個檔案的檔案頭都必須做檔案頭注釋。檔案頭注釋範例如下：

/** 檔案名稱：LoginActivity* 描    述：對使用者* 作    者：* 時    間：* 版    權：*/

 

 

                       

2、 方法頭注釋

每一個成員方法（包括自訂成員方法、覆蓋方法、屬性方法）的方法頭都必須做方法頭注釋。

自訂成員方法注釋範例如下：

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

 

 

覆蓋（重寫）成員方法注釋範例如下：

 

屬性getter和setter成員方法注釋範例如下： 

 

 

3、 塊注釋

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

 

 

 

4、 變數注釋

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

成員變數注釋的注釋範例如下：

 

局部變數注釋的注釋範例如下：

 

 

5、 語句注釋

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

語句注釋的注釋範例如下：

 

 

6、 有關注釋的其它說明

（1）   檔案頭和方法頭注釋應該使用/**/形式，變數注釋和語句注釋應該使用//形式，塊注釋應盡量使用//形式，當文字較長（單屏橫向不能顯示完全）時塊注釋也可以使用/**/形式；

（2）   注釋量必須不少於代碼總量的三分之一；

Java和Android注釋規範