Doxygen 注释规范

Doxygen 注释规范

💡 原文英文,约300词,阅读约需2分钟。
📝

内容提要

该文档介绍了基于Doxygen的C语言注释规范,包括文件头标注、结构体和枚举类型标注、函数头注释、变量注释和宏注释等。同时,文档提供了参考和致谢。

🎯

关键要点

  • 该文档介绍了基于Doxygen的C语言注释规范。
  • 文件头标注包括版权信息和文件描述。
  • 结构体和枚举类型的注释使用@brief和@details进行简要和详细说明。
  • 函数头注释包含函数的简要说明、详细说明、注意事项、参数说明和返回值说明。
  • 变量注释提供变量的简单和详细说明。
  • 宏注释使用@brief和@details进行简要和详细说明。
  • 文档最后提供了参考和致谢部分。
➡️

继续阅读