首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> 更多程式語言 >> 程式設計綜合問答

C 語言註釋風格:/* # */ 中井號號無特殊含義

     編輯:程式設計綜合問答

在《APUE》等經典 C 代碼中常見 /* # client structs to alloc/realloc for */ 形式的註釋,行首的 # 純屬作者個人風格,無任何語法或預處理含義。

風格分析

  • 視覺分隔:在大量註釋中,#、*、-、= 等字符用於區分功能模塊、重要程度或待辦事項。
  • 常見約定(非標準,團隊內部約定):
    • /* # */:重要說明、接口文檔、參數含義。
    • /* TODO */ / /* FIXME */:待完成/需修復。
    • /* ===== 模塊名 ===== */:文件區塊分隔。
  • 編譯器處理:C 編譯器預處理階段會移除所有 /* ... */ 註釋,# 只是註釋內容的一個普通字符,不觸發宏定義、條件編譯等預處理指令。

現代替代方案

現在推薦使用 Doxygen/Javadoc 風格 結構化註釋,工具可自動生成文檔:

/**
 * @brief 分配客戶端結構體數組
 * @param n 分配數量
 * @return 指向數組的指針
 */
#define NALLOC 10

結論:/* # */ 中的 # 只是作者習慣標記,閱讀代碼時可忽略,重點理解註釋傳達的技術信息。

  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved