将带有自定义项目的部分添加到类文档中？

Question

（C++）类的 Doxygen 文档有多个部分，例如“公共成员函数”和“私有属性”。我想添加一个自定义部分，其中包含不是我班级成员的条目。有办法吗？

具体来说，我的类有 * 方法，如 SetProperty(std::string name, int value)，它采用各种属性名称，我想记录属性名称的有效选项。现在我列出了支持属性的私有字段，并将属性名称放在 cmets 中，这有点不理想。

---

*) 在有人建议只更改代码之前，这个界面是出于我无法控制的原因而存在的，我无法更改它。这个想法是允许松散耦合并在脚本中设置类的属性。

Answer 1

Doxygen 支持Member groups 的概念，这正是您正在寻找的。只需像这样将成员括起来：

struct MyClass
{
  int nongroup_member;

  /*!
    \name MyGroupName
    Group description
    Note that this entire block is optional
  */
  //! @{
  int member_in_group;
  int another_member_in_group;
  //! @}
};

如果您要在组中记录的成员实际上并不作为成员存在，您应该能够在内部为它们引入“假”声明，并由一个宏控制的 #ifdef ... #endif 块，该宏仅定义为Doxygen 运行。