2.1 單行注釋
- 獨(dú)占一行的注釋惨驶，用來解釋下一行代碼白热。這行注釋之前總有一個(gè)空行，且縮進(jìn)層級(jí)和下一行代碼保持一致敞咧。
- 在代碼行的尾部注釋棘捣，代碼結(jié)束到注釋之間至少要有一個(gè)縮進(jìn)辜腺。注釋不應(yīng)該超過單行最大字?jǐn)?shù)限制休建，如果超過了，就將這條注釋放置于當(dāng)前代碼行上方评疗。
- 單行注釋不應(yīng)當(dāng)以連續(xù)多行注釋的形式出現(xiàn)测砂，除非你注釋掉的是一大段代碼。
- 只有當(dāng)要注釋掉一段很長的文本時(shí)才使用多行注釋百匆。
2.2 多行注釋
使用Java風(fēng)格的多行注釋
/*
* 這是一段注釋
* 這是第二行注釋
*/
- 第一行 /*
- 第二行 * 砌些，且和上一行對(duì)齊，且與內(nèi)容之間有一個(gè)空格
- 第三行 */
- 內(nèi)容從第二行開始寫加匈，最后一行沒有內(nèi)容
- 同單行注釋一樣存璃，注釋之前應(yīng)該有一個(gè)空行，且縮進(jìn)層級(jí)與要描述的代碼段保持一致
2.3 使用注釋
- 難于理解的代碼雕拼，當(dāng)代碼不夠清晰時(shí)添加注釋纵东，而當(dāng)代碼很明了時(shí)不應(yīng)當(dāng)添加注釋。
- 可能被別人誤認(rèn)為是錯(cuò)誤的代碼啥寇，其實(shí)他并不是錯(cuò)誤的偎球，要提醒別人
- 瀏覽器hack
2.4 文檔注釋
與多行注釋類似洒扎。以/**開始。使用@符號(hào)來不是屬性和參數(shù)
