C語言注釋簡介：
注釋應該出現在三種位置
- 文件頭部
- 函數頭部
- 函數體內的和代碼混在一起的注釋
對于文件頭部的注釋至少列出：
- 版權聲明、版本號、文件創建日期、作者、內容/功能、與其他文件的關系、修改日志等。
函數頭部注釋要求至少列出：
- 函數功能、輸入/輸出參數、返回值、調用/被調用關系等。
C語言注釋實例
注釋在預編譯階段就會被刪除掉，但是這里的刪除并不是字面意義的刪除，而是被替換，注釋被替換，本質是替換成空格。
以下面的代碼為例：
#include <stdio.h>
int main()
{
int /* */ i; //正確
char *s = "abcdefgh //hijklmn"; //正確
//Is it a\
valid comment? //正確
in/* */t j; //報錯
return 0;
}
由于被替換成了空格，所以in t j這句話是無法編譯的。
如果是C語言風格的注釋出現了嵌套，則/*總是與離它最近的*/匹配，第二個/*并不會被認為是注釋符號，因此第一個/*與第一個*/匹配，代碼會剩下一個*/:
注釋的一些注意事項
- 注釋應當準確、易懂，反之有二義性。錯誤的注釋容易產生誤導，不利于代碼維護。
- 邊寫代碼邊修改注釋，修改代碼的同時要修改對應的注釋，保證注釋和代碼的一致性。不再有用的注釋要及時刪除。
- 注釋是對代碼的“提示”，所以注釋應當簡單明了，因為注釋太多會讓人眼花繚亂。
- 對于全局數據（全局變量、常量定義等）必須要加注釋。注釋清楚定義全局數據的目的。
- 注釋的位置應該與被描述的代碼相鄰，可以與語句在同一行，也可以在語句的上一行，但不能在語句的下一行，因為這樣不符合人的閱讀習慣。
- 當代碼比較長，特別是有多重嵌套時，應當在一些段落結束時加注釋，便于閱讀。
- 注釋的縮進要與代碼的縮進一致，這樣代碼會更美觀，可讀性強。
- 注釋代碼段時應當注重“為何做”而不是“怎么做”，要說明這段代碼的操作意圖。
- 數值的單位一定要注釋。
- 對變量的范圍給出注釋，特別是參數。
- 對一系列的數字編號給出注釋，尤其是在編寫底層驅動的程序。
- 避免在一行代碼或表達式的中間插入注釋。
- 復雜的函數中，在分支語句、循環語句結束之后需要加注釋，方便區分各分支或循環體。
總結
到此這篇關于C語言中注釋與注意事項的文章就介紹到這了,更多相關C語言注釋與注意事項內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://blog.csdn.net/qq_52670477/article/details/120009186
