将包含自定义项的部分添加到课程文档？

Question

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

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

---

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

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