C語言中註釋與註意事項的深入講解

Posted on by

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語言風格的註釋出現瞭嵌套，則/*總是與離它最近的*/匹配，第二個/*並不會被認為是註釋符號，因此第一個/*與第一個*/匹配，代碼會剩下一個*/:

註釋的一些註意事項

  1. 註釋應當準確、易懂，反之有二義性。錯誤的註釋容易產生誤導，不利於代碼維護。
  2. 邊寫代碼邊修改註釋，修改代碼的同時要修改對應的註釋，保證註釋和代碼的一致性。不再有用的註釋要及時刪除。
  3. 註釋是對代碼的“提示”，所以註釋應當簡單明瞭，因為註釋太多會讓人眼花繚亂。
  4. 對於全局數據（全局變量、常量定義等）必須要加註釋。註釋清楚定義全局數據的目的。
  5. 註釋的位置應該與被描述的代碼相鄰，可以與語句在同一行，也可以在語句的上一行，但不能在語句的下一行，因為這樣不符合人的閱讀習慣。
  6. 當代碼比較長，特別是有多重嵌套時，應當在一些段落結束時加註釋，便於閱讀。
  7. 註釋的縮進要與代碼的縮進一致，這樣代碼會更美觀，可讀性強。
  8. 註釋代碼段時應當註重“為何做”而不是“怎麼做”，要說明這段代碼的操作意圖。
  9. 數值的單位一定要註釋。
  10. 對變量的范圍給出註釋，特別是參數。
  11. 對一系列的數字編號給出註釋，尤其是在編寫底層驅動的程序。
  12. 避免在一行代碼或表達式的中間插入註釋。
  13. 復雜的函數中，在分支語句、循環語句結束之後需要加註釋，方便區分各分支或循環體。

總結

到此這篇關於C語言中註釋與註意事項的文章就介紹到這瞭,更多相關C語言註釋與註意事項內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：