Android中合適的注釋方式是什么?

來源

http://www.cnblogs.com/SharkBin/p/3999804.html

1笛求、 文件頭注釋
每一個文件的文件頭都必須做文件頭注釋熬丧。文件頭注釋范例如下:

/*
* 文件名:LoginActivity
* 描    述:對用戶
* 作    者:
* 時    間:
* 版    權(quán):
*/

2导披、 方法頭注釋
每一個成員方法(包括自定義成員方法屈扎、覆蓋方法、屬性方法)的方法頭都必須做方法頭注釋撩匕。
自定義成員方法注釋范例如下:

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

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

Paste_Image.png

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

Paste_Image.png

3鹰晨、 塊注釋
在實現(xiàn)一段階段性功能的代碼前做塊注釋。塊注釋的注釋范例如下:

Paste_Image.png

4止毕、 變量注釋
所有的成員變量和大多數(shù)局部變量在聲明時都需要為其做功能注釋模蜡。
成員變量注釋的注釋范例如下:

Paste_Image.png

局部變量注釋的注釋范例如下:

Paste_Image.png

5、 語句注釋
在關(guān)鍵語句的右側(cè)要做單條語句注釋扁凛。
語句注釋的注釋范例如下:

Paste_Image.png

6忍疾、 有關(guān)注釋的其它說明
(1) 文件頭和方法頭注釋應(yīng)該使用//形式,變量注釋和語句注釋應(yīng)該使用//形式谨朝,塊注釋應(yīng)盡量使用//形式卤妒,當(dāng)文字較長(單屏橫向不能顯示完全)時塊注釋也可以使用//形式;
(2) 注釋量必須不少于代碼總量的三分之一字币;

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末则披,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子洗出,更是在濱河造成了極大的恐慌士复,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,000評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件翩活,死亡現(xiàn)場離奇詭異阱洪,居然都是意外死亡,警方通過查閱死者的電腦和手機菠镇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,745評論 3 399
  • 文/潘曉璐 我一進店門澄峰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人辟犀,你說我怎么就攤上這事俏竞。” “怎么了堂竟?”我有些...
    開封第一講書人閱讀 168,561評論 0 360
  • 文/不壞的土叔 我叫張陵魂毁,是天一觀的道長。 經(jīng)常有香客問我出嘹,道長席楚,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,782評論 1 298
  • 正文 為了忘掉前任税稼,我火速辦了婚禮烦秩,結(jié)果婚禮上垮斯,老公的妹妹穿的比我還像新娘。我一直安慰自己只祠,他們只是感情好兜蠕,可當(dāng)我...
    茶點故事閱讀 68,798評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著抛寝,像睡著了一般熊杨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上盗舰,一...
    開封第一講書人閱讀 52,394評論 1 310
  • 那天晶府,我揣著相機與錄音,去河邊找鬼钻趋。 笑死川陆,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的蛮位。 我是一名探鬼主播书劝,決...
    沈念sama閱讀 40,952評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼土至!你這毒婦竟也來了购对?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,852評論 0 276
  • 序言:老撾萬榮一對情侶失蹤陶因,失蹤者是張志新(化名)和其女友劉穎骡苞,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體楷扬,經(jīng)...
    沈念sama閱讀 46,409評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡解幽,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,483評論 3 341
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了烘苹。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片躲株。...
    茶點故事閱讀 40,615評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖镣衡,靈堂內(nèi)的尸體忽然破棺而出霜定,到底是詐尸還是另有隱情,我是刑警寧澤廊鸥,帶...
    沈念sama閱讀 36,303評論 5 350
  • 正文 年R本政府宣布望浩,位于F島的核電站,受9級特大地震影響惰说,放射性物質(zhì)發(fā)生泄漏磨德。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,979評論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望典挑。 院中可真熱鬧酥宴,春花似錦、人聲如沸您觉。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,470評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽顾犹。三九已至,卻和暖如春褒墨,著一層夾襖步出監(jiān)牢的瞬間炫刷,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,571評論 1 272
  • 我被黑心中介騙來泰國打工郁妈, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留浑玛,地道東北人。 一個月前我還...
    沈念sama閱讀 49,041評論 3 377
  • 正文 我出身青樓噩咪,卻偏偏與公主長得像顾彰,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子胃碾,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,630評論 2 359

推薦閱讀更多精彩內(nèi)容

  • 1. Java基礎(chǔ)部分 基礎(chǔ)部分的順序:基本語法涨享,類相關(guān)的語法,內(nèi)部類的語法仆百,繼承相關(guān)的語法厕隧,異常的語法,線程的語...
    子非魚_t_閱讀 31,664評論 18 399
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,302評論 25 707
  • 得到函數(shù)的名字俄周。按照優(yōu)先級來進行區(qū)分
    基本密碼宋閱讀 327評論 0 0
  • 總是潛意識里凡事都要準備好吁讨,可每次都沒有準備好,都不近人意峦朗,所以準備是在平常建丧,不是在事發(fā)前,如果盡力了波势,還是沒有達...
    滄海2016閱讀 244評論 0 1
  • 今天的文章內(nèi)容仍是永澄老師的領(lǐng)讀活動。還記得在第一堂課上迄埃,老師講到:什么叫高維度疗韵?就是信息密度高發(fā)的區(qū)域。那么侄非,4...
    職心眼兒閱讀 695評論 0 2