doxygen 一次注释多个变量答案

【问题标题】：doxygen comment multiple variables at oncedoxygen 一次注释多个变量
【发布时间】：2011-08-12 06:55:16
【问题描述】：

如果我有以下情况：

/**
 * @brief (x,y,z) points for block
 */
int x, y, z;

它只会为 x 生成该文档，在 doxygen 中是否有可能让它用一个评论来评论所有 x、y 和 z？

编辑按照 envu 的建议，我现在有以下内容（基于http://www.doxygen.nl/manual/grouping.html#memgroup）

//@{
/** some documentation here */
int x, y, z;
//@}

或

//@{
/**
 * @brief some documentation here
 */
int x, y, z;
//@}

然而，这两个仍然只是文档 x。尝试使用不同的形式我还没有获得相同的文档字符串来跨越多个变量

【问题讨论】：

标签： c++ c variables doxygen comments

【解决方案1】：

一段时间以来一直在努力解决这个问题。原来你必须在配置中设置DISTRIBUTE_GROUP_DOC = YES。

【讨论】：

【解决方案2】：

我会为此使用 成员组 http://www.doxygen.nl/manual/grouping.html#memgroup。语法和输出与您想要实现的有点不同，但我认为这不应该受到伤害。

【讨论】：

感谢您的帖子，我仍然无法正常工作。请查看我的更新帖子了解我的尝试。
是的，它只会记录x。不幸的是，写int x; int y,z; 似乎也不起作用。也许提交一个错误？
接受了，因为没有更好的结果，它可能是 doxygen 或其文档的错误。
@cjh 我对成员函数组有同样的问题。我认为这是一个错误。

【解决方案3】：

我意识到这是一个老问题，但我一直有一个类似的问题，并找到了一个不能完全解决问题但在某些情况下可能是可接受的替代方案的解决方法。

通过在成员组块上方添加注释并在其前面加上 \name 装饰器前缀，您将获得显示在 Doxygen 页面属性列表中成员组中所有变量上方的描述。我相信这是一个简短的描述，但如果你愿意，你可以在这里放任意长的描述。

这并没有将相同的 cmets 放在成员组中每个变量的详细信息字段中（详细信息字段将为空，或者如果您在成员组块中放置注释，它仍然会仅适用于第一个变量），但它确实具有将一组相关变量记录在一起的效果，这似乎是问题的初衷。

例子：

/*! \name This will be the description for the following group of variables
          It can be arbitrarily long, but the first line will show up in bold,
          and any subsequent lines will show up like a description under it
*/
//@{
int relatedVariable1;
int relatedVariable2;
char* relatedVariable3;
//@}

【讨论】：

【解决方案4】：

我在“专家”标签中设置了“DISTRIBUTE_GROUP_DOC”选项。他们小组的所有成员都收到了相同的评论。

//@{
/** same comment for all members */
char aaa;
char bbb;
int ccc;
//@}

【讨论】：