Java和Android注釋規範

2021-09-06 18:27:55 字數 1625 閱讀 9025

1、檔案頭注釋

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

/*

* 檔名:loginactivity

* 描 述:對使用者

* 作 者:

* 時 間:

* 版 權:

2、方法頭注釋

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

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

/*

* 方法名:login_click(view v)

* 功    能:單擊登入按鈕的事件

* 參    數:view v - 按鈕的view

* 返回值:無

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

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

3、塊注釋

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

4、變數注釋

所有的成員變數和大多數區域性變數在宣告時都需要為其做功能注釋。

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

區域性變數注釋的注釋範例如下:

5、語句注釋

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

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

6、有關注釋的其它說明

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

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

mysql約規表注釋 mysql 表注釋和字段注釋

1 建立表的時候寫注釋 create table test1 field name int comment 欄位的注釋 comment 表的注釋 2 修改表的注釋 alter table test1 comment 修改後的表的注釋 3 修改欄位的注釋 alter table test1 modif...

關於 java注釋

用於說明 用途,作者,建立時間,輸出引數型別,可能丟擲的異常,返回值 注釋量要佔總 量20 以上引數的型別 如下 main方法是一切程式執行的入口 author 趙濤 since 201811 11 param args string 輸出引數型別為字串陣列,引數名字為args return 無返回...

Android 特殊注釋技術

todo 說明 如果 中有該標識,說明在標識處有功能 待編寫,待實現的功能在說明中會簡略說明。fixme 說明 如果 中有該標識,說明標識處 需要修正,甚至 是錯誤的,不能工作,需要修復,如何修正會在說明中簡略說明。說明 如果 中有該標識,說明標識處 雖然實現了功能,但是實現的方法有待商榷,希望將來...