爲什麼C評論像/ * */need'<'？

Question

我的團隊C代碼編寫的指導方針，它會更好，在註釋放置一個「<」如下圖所示：

#define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 

我不知道，什麼是真正的利用這一「<」？

Answer 1

這是doxygen爲文件/結構/聯合/類/枚舉的成員生成文檔的一種方式。通過使用該標記，您可以在每個成員之後發表評論，從而減少混亂。你可以閱讀更多關於它here。

Answer 2

我假設你的團隊使用一些自動文檔工具，它尋找/**<;例如Doxygen。

Answer 3

這是一個doxygen syntax用於在聲明/定義後評論成員。

Answer 4

正如其他人已經回覆，這可能是一個意見，是爲了doxygen。當分析評論，Doxygen的有一些特殊的規則：

• 一個普通的評論開始/*是忽略由doxygen的。
• 以/**開頭的評論被視爲源代碼中評論下一項的文檔。
• 以/**<開頭的評論被視爲之前源代碼中的註釋的文檔。

文檔大多放置在記錄的項目上方，例如，一個函數。但在某些情況下，例如#define，將文檔放在行末是有意義的，在這種情況下，需要使用/**<標記。