嵌入式 C 語言代碼注釋規(guī)范

我是老溫，一名熱愛學(xué)習(xí)的嵌入式工程師
關(guān)注我，一起變得更加優(yōu)秀！看一份源碼什么很重要？除了各種代碼規(guī)范之外，還有一個比較重要的就是注釋。
注釋雖然寫起來很痛苦, 但對保證代碼可讀性至關(guān)重要，下面將介紹一下如何注釋以及在哪兒注釋。注釋風(fēng)格
1、總述一般使用 // 或 /* */，只要統(tǒng)一就好。

2、說明// 或 /* */ 都可以，但 // 更常用，要在如何注釋及注釋風(fēng)格上確保統(tǒng)一。
文件注釋
1、總述在每一個文件開頭加入版權(quán)、作者、時間等描述。
文件注釋描述了該文件的內(nèi)容，如果一個文件只聲明，或?qū)崿F(xiàn)，或測試了一個對象，并且這個對象已經(jīng)在它的聲明處進(jìn)行了詳細(xì)的注釋，那么就沒必要再加上文件注釋，除此之外的其他文件都需要文件注釋。
2、說明
法律公告和作者信息：每個文件都應(yīng)該包含許可證引用. 為項目選擇合適的許可證版本(全球各種開源協(xié)議介紹)。
如果你對原始作者的文件做了重大修改，請考慮刪除原作者信息。
3、文件內(nèi)容如果一個 .h 文件聲明了多個概念, 則文件注釋應(yīng)當(dāng)對文件的內(nèi)容做一個大致的說明, 同時說明各概念之間的聯(lián)系. 一個一到兩行的文件注釋就足夠了, 對于每個概念的詳細(xì)文檔應(yīng)當(dāng)放在各個概念中, 而不是文件注釋中。不要在 .h 和 .cc 之間復(fù)制注釋, 這樣的注釋偏離了注釋的實際意義。函數(shù)注釋
1、總述
函數(shù)聲明處的注釋描述函數(shù)功能; 定義處的注釋描述函數(shù)實現(xiàn)。2、說明函數(shù)聲明：基本上每個函數(shù)聲明處前都應(yīng)當(dāng)加上注釋, 描述函數(shù)的功能和用途. 只有在函數(shù)的功能簡單而明顯時才能省略這些注釋(例如, 簡單的取值和設(shè)值函數(shù))。比如：FreeRTOS創(chuàng)建任務(wù)函數(shù)聲明：

函數(shù)定義：如果函數(shù)的實現(xiàn)過程中用到了很巧妙的方式, 那么在函數(shù)定義處應(yīng)當(dāng)加上解釋性的注釋。
比如, 你所使用的編程技巧, 實現(xiàn)的大致步驟, 或解釋如此實現(xiàn)的理由. 舉個例子, 你可以說明為什么函數(shù)的前半部分要加鎖而后半部分不需要。
不要 從 .h 文件或其他地方的函數(shù)聲明處直接復(fù)制注釋. 簡要重述函數(shù)功能是可以的, 但注釋重點要放在如何實現(xiàn)上。變量注釋
1、總述
通常變量名本身足以很好說明變量用途， 某些情況下, 也需要額外的注釋說明。2、說明根據(jù)不同場景、不同修飾符，變量可以分為很多種類，總的來說變量分為全局變量、局部變量。一般來說局部變量僅限于局部范圍，其含義相對簡單容易理解，只需要簡單注釋即可。全局變量一般作用于多個文件，或者整個工程，因此，其含義相對更復(fù)雜，所以在注釋的時候，最好描述清楚其具體含義，就是盡量全面描述。
（提示：全局變量盡量少用）拼寫注釋
1、總述
可能一個變量、一個函數(shù)包含的意思非常復(fù)雜，需要多個單詞拼寫而成，此時對拼寫內(nèi)容就需要詳細(xì)注釋。2、說明注釋的通常寫法是包含正確大小寫和結(jié)尾句號的完整敘述性語句. 大多數(shù)情況下, 完整的句子比句子片段可讀性更高. 短一點的注釋, 比如代碼行尾注釋, 可以隨意點, 但依然要注意風(fēng)格的一致性。同時，注釋中的拼寫、逗號也很重要。雖然被別人指出該用分號時卻用了逗號多少有些尷尬, 但清晰易讀的代碼還是很重要的. 正確的標(biāo)點, 拼寫和語法對此會有很大幫助。TODO 注釋
1、總述
對那些臨時的, 短期的解決方案, 或已經(jīng)夠好但仍不完美的代碼使用 TODO 注釋。TODO 注釋要使用全大寫的字符串 TODO, 在隨后的圓括號里寫上你的名字, 郵件地址, bug ID, 或其它身份標(biāo)識和與這一 TODO 相關(guān)的 issue. 主要目的是讓添加注釋的人 (也是可以請求提供更多細(xì)節(jié)的人) 可根據(jù)規(guī)范的 TODO 格式進(jìn)行查找. 添加 TODO 注釋并不意味著你要自己來修正, 因此當(dāng)你加上帶有姓名的 TODO 時, 一般都是寫上自己的名字。棄用注釋
1、總述
通過棄用注釋（DEPRECATED comments）以標(biāo)記某接口點已棄用.您可以寫上包含全大寫的 DEPRECATED 的注釋, 以標(biāo)記某接口為棄用狀態(tài). 注釋可以放在接口聲明前, 或者同一行.在 DEPRECATED 一詞后, 在括號中留下您的名字, 郵箱地址以及其他身份標(biāo)識.棄用注釋應(yīng)當(dāng)包含簡短而清晰的指引, 以幫助其他人修復(fù)其調(diào)用點. 在 C++ 中, 你可以將一個棄用函數(shù)改造成一個內(nèi)聯(lián)函數(shù), 這一函數(shù)將調(diào)用新的接口.僅僅標(biāo)記接口為 DEPRECATED 并不會讓大家不約而同地棄用, 您還得親自主動修正調(diào)用點（callsites）, 或是找個幫手.修正好的代碼應(yīng)該不會再涉及棄用接口點了, 注釋改用新接口點. 如果你不知從何下手, 可以找標(biāo)記棄用注釋的當(dāng)事人一起商量。結(jié)語
注釋固然很重要, 但最好的代碼應(yīng)當(dāng)本身就是文檔，有意義的類型名和變量名, 要遠(yuǎn)勝過要用注釋解釋的含糊不清的名字。
你寫的注釋是給代碼閱讀者看的, 也就是下一個需要理解你代碼的人. 所以慷慨些吧, 下一個讀者可能就是你！
文章來源于網(wǎng)絡(luò)，版權(quán)歸原作者所有，如有侵權(quán)，請聯(lián)系刪除。

-END-
往期推薦：點擊圖片即可跳轉(zhuǎn)閱讀
                                                       
                                                               
                                                                       
                                                                               

                                                                               
                                                                                        2023，8月過半
                                                                               
                                                                       
                                                               
                                                       
                                               

                                                       
                                                               
                                                                       
                                                                               

                                                                               
                                                                                        簡述嵌入式系統(tǒng)開發(fā)的一些特殊性
                                                                               
                                                                       
                                                               
                                                       
                                               

                                                       
                                                               
                                                                       
                                                                               

                                                                               
                                                                                        全面講解 C 語言斷言函數(shù)的應(yīng)用
                                                                               
                                                                       
                                                               
                                                       
                                               
我是老溫，一名熱愛學(xué)習(xí)的嵌入式工程師
關(guān)注我，一起變得更加優(yōu)秀！