Java和Android註釋規範

一、 文件頭註釋

每個文件的文件頭都必須作文件頭註釋。文件頭註釋範例以下：

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

 

 

                       

二、 方法頭註釋

每個成員方法（包括自定義成員方法、覆蓋方法、屬性方法）的方法頭都必須作方法頭註釋。

自定義成員方法註釋範例以下：

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

 

 

覆蓋（重寫）成員方法註釋範例以下：

 

屬性getter和setter成員方法註釋範例以下： 

 

 

三、 塊註釋

在實現一段階段性功能的代碼前作塊註釋。塊註釋的註釋範例以下：

 

 

 

四、 變量註釋

全部的成員變量和大多數局部變量在聲明時都須要爲其作功能註釋。

成員變量註釋的註釋範例以下：

 

局部變量註釋的註釋範例以下：

 

 

五、 語句註釋

在關鍵語句的右側要作單條語句註釋。

語句註釋的註釋範例以下：

 

 

六、 有關注釋的其它說明

（1）   文件頭和方法頭註釋應該使用/**/形式，變量註釋和語句註釋應該使用//形式，塊註釋應儘可能使用//形式，當文字較長（單屏橫向不能顯示徹底）時塊註釋也可使用/**/形式；

（2）   註釋量必須很多於代碼總量的三分之一；