C語言如何注釋以及在哪兒注釋
如果領導給你一個項目的源碼讓你閱讀，并理解重構代碼，但里面一句注釋都沒有，我想這肯定是之前同事“刪庫跑路”了。 看一份源碼什么很重要？除了各種代碼規范之外，還有一個比較重要的就是注釋。 注釋雖然寫起來很痛苦, 但對保證代碼可讀性至關重要，下面的將描述如何注釋以及在哪兒注釋。
注釋風格
1.總述
一般使用//或/**/，只要統一就好。
2.說明
//或/**/都可以，但//更常用，要在如何注釋及注釋風格上確保統一。
文件注釋
1.總述在每一個文件開頭加入版權、作者、時間等描述。 文件注釋描述了該文件的內容，如果一個文件只聲明，或實現，或測試了一個對象，并且這個對象已經在它的聲明處進行了詳細的注釋，那么就沒必要再加上文件注釋，除此之外的其他文件都需要文件注釋。 2.說明法律公告和作者信息：每個文件都應該包含許可證引用. 為項目選擇合適的許可證版本(比如, Apache 2.0, BSD, LGPL, GPL)。 如果你對原始作者的文件做了重大修改，請考慮刪除原作者信息。 3.文件內容
如果一個.h文件聲明了多個概念, 則文件注釋應當對文件的內容做一個大致的說明, 同時說明各概念之間的聯系. 一個一到兩行的文件注釋就足夠了, 對于每個概念的詳細文檔應當放在各個概念中, 而不是文件注釋中。
不要在.h和.cc之間復制注釋, 這樣的注釋偏離了注釋的實際意義。
函數注釋
1.總述函數聲明處的注釋描述函數功能; 定義處的注釋描述函數實現。 2.說明函數聲明：基本上每個函數聲明處前都應當加上注釋, 描述函數的功能和用途. 只有在函數的功能簡單而明顯時才能省略這些注釋(例如, 簡單的取值和設值函數)。 比如：FreeRTOS創建任務函數申明：
不要從.h文件或其他地方的函數聲明處直接復制注釋. 簡要重述函數功能是可以的, 但注釋重點要放在如何實現上。
變量注釋
1.總述通常變量名本身足以很好說明變量用途， 某些情況下, 也需要額外的注釋說明。2.說明根據不同場景、不同修飾符，變量可以分為很多種類，總的來說變量分為全局變量、局部變量。 一般來說局部變量僅限于局部范圍，其含義相對簡單容易理解，只需要簡單注釋即可。 全局變量一般作用于多個文件，或者整個工程，因此，其含義相對更復雜，所以在注釋的時候，最好描述清楚其具體含義，就是盡量全面描述。（提示：全局變量盡量少用）
拼音注釋
1.總述可能一個變量、一個函數包含的意思非常復雜，需要多個單詞拼寫而成，此時對拼寫內容就需要詳細注釋。2.說明注釋的通常寫法是包含正確大小寫和結尾句號的完整敘述性語句. 大多數情況下, 完整的句子比句子片段可讀性更高. 短一點的注釋, 比如代碼行尾注釋, 可以隨意點, 但依然要注意風格的一致性。 同時，注釋中的拼寫、逗號也很重要。雖然被別人指出該用分號時卻用了逗號多少有些尷尬, 但清晰易讀的代碼還是很重要的. 正確的標點, 拼寫和語法對此會有很大幫助
TODO 注釋
1.總述對那些臨時的, 短期的解決方案, 或已經夠好但仍不完美的代碼使用TODO注釋。TODO注釋要使用全大寫的字符串TODO, 在隨后的圓括號里寫上你的名字, 郵件地址, bug ID, 或其它身份標識和與這一TODO相關的 issue. 主要目的是讓添加注釋的人 (也是可以請求提供更多細節的人) 可根據規范的TODO格式進行查找. 添加TODO注釋并不意味著你要自己來修正, 因此當你加上帶有姓名的TODO時, 一般都是寫上自己的名字。最后
注釋固然很重要, 但最好的代碼應當本身就是文檔，有意義的類型名和變量名, 要遠勝過要用注釋解釋的含糊不清的名字。
你寫的注釋是給代碼閱讀者看的, 也就是下一個需要理解你代碼的人. 所以慷慨些吧, 下一個讀者可能就是你！
審核編輯 ：李倩
聲明：本文內容及配圖由入駐作者撰寫或者入駐合作網站授權轉載。文章觀點僅代表作者本人，不代表電子發燒友網立場。文章及其配圖僅供工程師學習之用，如有內容侵權或者其他違規問題，請聯系本站處理。
舉報投訴
-
C語言
+關注
關注
180文章
7614瀏覽量
137727 -
代碼
+關注
關注
30文章
4828瀏覽量
69055
原文標題：C語言的注釋要注意幾點
文章出處：【微信號：strongerHuang，微信公眾號：strongerHuang】歡迎添加關注！文章轉載請注明出處。
發布評論請先 登錄
相關推薦
C語言關鍵字分別發生在哪個階段
以下C語言關鍵字，分別發生在哪個階段？ 第一個，define。 首先得糾正一下，define 并不是C語言里面的關鍵字，即使加了井號，也不是
PCM2707為什么無法被電腦識別？
現在只焊接了最基礎的部分,其它如控制跟I2S接口都還沒連接元件,相當于空接,,現在無法被電腦識別,系統WI8-64BIT,我購買的PCM2704的板可以被電腦正常識別,請問下,問題出在哪兒
發表于 11-06 06:25
請問有沒有單片機通過I2C配置AIC3204的相關例程，或者在哪兒可以找到？
請問有沒有單片機通過I2C配置AIC3204的相關例程，或者在哪兒可以找到？例如設置AIC3204的ADC等
發表于 11-01 07:36
C語言與Java語言的對比
C語言和Java語言都是當前編程領域中的重要成員，它們各自具有獨特的優勢和特點，適用于不同的應用場景。以下將從語法特性、內存管理、跨平臺性、性能、應用領域等多個方面對C
新能源機車電傳動系統“新”在哪兒
中國中車面向全球首次發布系列化新能源機車，7款代表車型集中亮相。中車永濟電機公司為系列化新能源機車研制開發了電傳動系統解決方案，包括牽引輔助變流系統、牽引電機、網絡控制系統等核心部件。
LMH6882增益輸出異常是什么原因導致的？
實際測試中LMH6882的差分輸出與差分輸入的比值為1.9
調整其他增益大小，實際增益與設定增益也是有差值，不知道怎么回事，
使用TINA仿真原理圖也是正常的，不知道問題出現在哪兒了
發表于 08-08 07:30
TLV3601比較器輸出方波失真是什么原因導致的？
（直流偏置2V，幅值1V，1MHz），然后輸入到TLV3601芯片里，輸出依然變成了一個失真的方波
現在不知道問題在哪兒，因為仿真是正確的，求大神指點一下，萬分感謝！
發表于 08-01 07:55
TLV2252A運放產生了低頻振蕩是哪里出了問題？
如圖所示，本人用作一個紅外傳感器的驅動，但是運放輸出莫名的振蕩了，請幫忙看看原因是什么了？ 輸出振蕩信號為參考電壓（225mv）到軌電壓（3V3）的一個低頻振蕩（2.46HZ）。
請大拿們幫忙看看問題出在哪兒了？
發表于 07-31 06:52
esp8266向http server發送post請求，發送一段時間之后會返回ESPCONN_MEM，為什么？
callback，然后再發下一包，我不知道tcp_pcb是在哪兒close和刪除的，我嘗試在disconnect callback和reconnect callback中調用espconn_delete或
發表于 07-10 08:13
ESP-ADF例程編譯過程出錯，提示找不到“esp_afe_sr_iface.h”文件，為什么？
ESP-ADF例程編譯過程出錯，提示找不到“esp_afe_sr_iface.h”文件，在github和gitee倉庫上找遍了也沒有這個文件，請問有大神知道在哪兒有嗎？
發表于 06-17 08:03
PLC編程語言和C語言的區別
在工業自動化和計算機編程領域中，PLC（可編程邏輯控制器）編程語言和C語言各自扮演著重要的角色。盡管兩者都是編程語言，但它們在多個方面存在顯著的區別。本文將從多個維度深入探討PLC編程
在哪兒可以修改DAC口的輸出變量？
大家好，就是workbench生成程序的時候，會在DAC那里選擇通道的輸出信息。然后脫離Workbench想在程序里直接修改的時候在dac_ui.c里往下找的時候，找到了在user_interface.h里邊有很多這個定義，但就是沒明白在哪兒可以修改DAC口的輸出變量。所
發表于 04-02 06:45
NUCLEO-G474RE開發板的例程在哪兒下載？如和用usb和pc串口通信？
NUCLEO-G474RE這個開發板的例程在哪兒下載啊，不知道如和用他的usb和pc串口通信
發表于 03-18 08:22
工商網監
評論