c語言註釋要點

C語言註釋簡介:
註釋應該出現在三種位置

  • 文件頭部
  • 函數頭部
  • 函數體內的和代碼混在一起的註釋

對於文件頭部的註釋至少列出:
版權聲明、版本號、文件創建日期、作者、內容/功能、與其他文件的關係、修改日誌等。

函數頭部註釋要求至少列出:
函數功能、輸入/輸出參數、返回值、調用/被調用關係等。

注意點:

  • 對於放在代碼上方的註釋有時還會和上方其他代碼用一個空行隔開
  • 全局變量應減少使用,必須使用時要有詳細的註釋。包括功能/作用、取值範圍、調用者、注意事項等
  • 標識符、關鍵字之間必須至少加一個空格以示間隔
  • 功能上相對獨立的程序塊之間加一個空行
  • 對於過長的語句,應該從低優先級運算符處拆分成多行
  • 對於長表達式,應該從低優先級運算符處拆分成多行
  • 如果函數參數過長,也要拆分
發佈了25 篇原創文章 · 獲贊 4 · 訪問量 1萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章