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

Question

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

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

---

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

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 block 中为他们引入“假”声明由仅为 Doxygen 运行定义的宏控制。