使用Doxygen时，注释应置于实体前还是实体后？

Doxygen不强制要求注释必须放在实体之前，完全支持后置注释的风格，但需要使用特定的语法标记来让Doxygen识别这是关联到对应实体的文档注释。

后置注释的常用写法： #

• 单行后置注释：使用 ///< 或 //!< 标记，直接跟在实体后面：

  int foo; ///< 这是关于foo的Doxygen注释
  int bar; //!< 这也是关于bar的Doxygen注释
  

• 多行后置注释：可以每行都加 ///<，或者使用块注释 /*!< ... */：

  int foo; 
  ///< 这是关于foo的多行Doxygen注释
  ///< 第二行内容
  

  块注释写法：

  int bar; /*!< 
  这是关于bar的多行块级Doxygen注释
  第二行内容
  */
  

注意事项： #

• 后置注释的缩进不会影响Doxygen的识别，但为了代码可读性，建议保持统一的缩进风格
• 后置注释更适合简单实体（如变量、枚举值），对于函数、类、结构体这类复杂实体，前置注释的结构会更清晰，也更符合大多数团队的编码习惯

内容的提问来源于stack exchange，提问作者einpoklum