将包含自定义项的部分添加到类文档中

Question

（C++）类的Doxygen文档有"公共成员函数"和"私有属性"等多个部分。我想添加一个自定义部分，其中包含不属于我的类成员的条目。有没有办法做到这一点？

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

---

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

Answer 1

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

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运行定义。