Android/Java 代碼注釋標准規范


1、 ⽂件頭注釋
   每⼀個⽂件的⽂件頭都必須做⽂件頭注釋。⽂件頭注釋范例如下:
 
2、 ⽅法頭注釋
  每⼀個成員⽅法(包括⾃定義成員⽅法、覆蓋⽅法、屬性⽅法)的⽅法頭都必須做⽅法頭注釋。
   ⾃定義成員⽅法注釋范例如下:
 
   覆蓋(重寫)成員⽅法注釋范例如下:
 

 

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

 3、 塊注釋

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

 4、 變量注釋

所有的成員變量和⼤多數局部變量在聲明時都需要為其做功能注釋。
成員變量注釋的注釋范例如下:
 
 
局部變量注釋的注釋范例如下:
 
5、 語句注釋
在關鍵語句的右側要做單條語句注釋。
語句注釋的注釋范例如下:
 

 6、 有關注釋的其它說明

(1) ⽂件頭和⽅法頭注釋應該使⽤/**/形式,變量注釋和語句注釋應該使
⽤//形式,塊注釋應盡量使⽤//形式,當⽂字較長(單屏橫向不能顯
⽰完全)時塊注釋也可以使⽤/**/形式;
(2) 注釋量必須不少於代碼總量的三分一

 


免責聲明!

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



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