1. 程式人生 > >程式碼註釋規範

程式碼註釋規範

1.檔案註釋
檔案註釋寫在文件頭部,以/*開頭,例:

/ *
* 檔名:[檔名]
* 作者:〈版權〉
* 描述:〈描述〉
* 修改人:〈修改人〉
* 修改時間:YYYY-MM-DD
 * 修改內容:〈修改內容〉
  */

2.類和介面的註釋
說明該類或者介面的功能、作用、使用方法和注意事項,每次修改後增加作者和更新版本號和日期

/ *
 * 〈一句話功能簡述〉 
* 〈功能詳細描述〉
* @author [作者]
* @version [版本號, YYYY-MM-DD]
* @see [相關類/方法]
* @since [產品/模組版本]
* @deprecated
*/

3.成員變數
註釋內容:成員變數的意義、目的、功能,可能被用到的地方。用//來註釋,需要對齊被註釋程式碼。

4.公有和保護方法
註釋內容:列出方法的一句話功能簡述、功能詳細描述、輸入引數、輸出引數、返回值、違例等。

注意事項:
1.邊寫程式碼邊註釋,修改程式碼同時修改相應的註釋,以保證註釋與程式碼的一致性。不再有用的註釋要刪除。
2.避免在註釋中使用縮寫,特別是不常用縮寫。說明:在使用縮寫時或之前,應對縮寫進行必要的說明。 註釋應該放在被註釋的程式碼前面,分行展示,但中間不留空行。