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