看一份源碼什么很重要？除了各種代碼規范之外，還有一個比較重要的就是注釋。

注釋雖然寫起來很痛苦, 但對保證代碼可讀性至關重要，下面將介紹一下如何注釋以及在哪兒注釋。

注釋風格

1、總述

一般使用//或/**/，只要統一就好。

2、說明

//或/**/都可以，但//更常用，要在如何注釋及注釋風格上確保統一。

文件注釋

1、總述

在每一個文件開頭加入版權、作者、時間等描述。

文件注釋描述了該文件的內容，如果一個文件只聲明，或實現，或測試了一個對象，并且這個對象已經在它的聲明處進行了詳細的注釋，那么就沒必要再加上文件注釋，除此之外的其他文件都需要文件注釋。

2、說明

法律公告和作者信息： 每個文件都應該包含許可證引用. 為項目選擇合適的許可證版本(全球各種開源協議介紹)。

如果你對原始作者的文件做了重大修改，請考慮刪除原作者信息。

3、文件內容

如果一個 .h 文件聲明了多個概念, 則文件注釋應當對文件的內容做一個大致的說明, 同時說明各概念之間的聯系. 一個一到兩行的文件注釋就足夠了, 對于每個概念的詳細文檔應當放在各個概念中, 而不是文件注釋中。

不要在 .h 和 .cc 之間復制注釋, 這樣的注釋偏離了注釋的實際意義。

函數注釋

1、總述

函數聲明處的注釋描述函數功能; 定義處的注釋描述函數實現。

2、說明

函數聲明：基本上每個函數聲明處前都應當加上注釋, 描述函數的功能和用途. 只有在函數的功能簡單而明顯時才能省略這些注釋(例如, 簡單的取值和設值函數)。

比如：FreeRTOS創建任務函數聲明：

函數定義：如果函數的實現過程中用到了很巧妙的方式, 那么在函數定義處應當加上解釋性的注釋。

比如, 你所使用的編程技巧, 實現的大致步驟, 或解釋如此實現的理由. 舉個例子, 你可以說明為什么函數的前半部分要加鎖而后半部分不需要。

不要從.h文件或其他地方的函數聲明處直接復制注釋. 簡要重述函數功能是可以的, 但注釋重點要放在如何實現上。

變量注釋

1、總述

通常變量名本身足以很好說明變量用途， 某些情況下, 也需要額外的注釋說明。

2、說明

根據不同場景、不同修飾符，變量可以分為很多種類，總的來說變量分為全局變量、局部變量。

一般來說局部變量僅限于局部范圍，其含義相對簡單容易理解，只需要簡單注釋即可。

全局變量一般作用于多個文件，或者整個工程，因此，其含義相對更復雜，所以在注釋的時候，最好描述清楚其具體含義，就是盡量全面描述。 （提示：全局變量盡量少用）

拼寫注釋

1、總述

可能一個變量、一個函數包含的意思非常復雜，需要多個單詞拼寫而成，此時對拼寫內容就需要詳細注釋。

2、說明

注釋的通常寫法是包含正確大小寫和結尾句號的完整敘述性語句. 大多數情況下, 完整的句子比句子片段可讀性更高. 短一點的注釋, 比如代碼行尾注釋, 可以隨意點, 但依然要注意風格的一致性。

同時，注釋中的拼寫、逗號也很重要。

雖然被別人指出該用分號時卻用了逗號多少有些尷尬, 但清晰易讀的代碼還是很重要的. 正確的標點, 拼寫和語法對此會有很大幫助。

TODO 注釋

1、總述

對那些臨時的, 短期的解決方案, 或已經夠好但仍不完美的代碼使用 TODO 注釋。

TODO 注釋要使用全大寫的字符串 TODO, 在隨后的圓括號里寫上你的名字, 郵件地址, bug ID, 或其它身份標識和與這一 TODO 相關的 issue. 主要目的是讓添加注釋的人 (也是可以請求提供更多細節的人) 可根據規范的 TODO 格式進行查找. 添加 TODO 注釋并不意味著你要自己來修正, 因此當你加上帶有姓名的 TODO 時, 一般都是寫上自己的名字。

棄用注釋

1、總述

通過棄用注釋（DEPRECATEDcomments）以標記某接口點已棄用. 您可以寫上包含全大寫的DEPRECATED的注釋, 以標記某接口為棄用狀態. 注釋可以放在接口聲明前, 或者同一行. 在DEPRECATED一詞后, 在括號中留下您的名字, 郵箱地址以及其他身份標識. 棄用注釋應當包含簡短而清晰的指引, 以幫助其他人修復其調用點. 在 C++ 中, 你可以將一個棄用函數改造成一個內聯函數, 這一函數將調用新的接口. 僅僅標記接口為DEPRECATED并不會讓大家不約而同地棄用, 您還得親自主動修正調用點（callsites）, 或是找個幫手. 修正好的代碼應該不會再涉及棄用接口點了, 注釋改用新接口點. 如果你不知從何下手, 可以找標記棄用注釋的當事人一起商量。

結語

注釋固然很重要, 但最好的代碼應當本身就是文檔，有意義的類型名和變量名, 要遠勝過要用注釋解釋的含糊不清的名字。

你寫的注釋是給代碼閱讀者看的, 也就是下一個需要理解你代碼的人. 所以慷慨些吧, 下一個讀者可能就是你！

審核編輯：劉清