将点放在简要说明中答案

【问题标题】：Put dot in brief description将点放在简要说明中
【发布时间】：2015-04-01 13:22:40
【问题描述】：

我得到了这个示例代码。我想在我的简短评论中加上一个点。

const int myVar = 1;   //!< Doxygen very long brief\.
                       //!  Brief sentence two.

我按照 doxygen 手册中的说明转义了点。这不起作用。第一行是简短的，第二行是详细的。这是一个错误吗？

注意：MULTILINE_CPP_IS_BRIEF 和 QT_AUTOBRIEF 是 YES！我使用的是最新版本（1.8.9.1）。

【问题讨论】：

我认为换行符可能很重要。如果你只使用一行会发生什么？
输出相同。
“即”也出现问题和“例如”，所以这是一个真正的问题。然而，一个可能的解决方案是 \ie 和 \eg，它们现在不存在，afaik。

标签： doxygen

【解决方案1】：

doxygen manual 说

如果您启用此选项并希望在句子中间放一个点而不结束它，您应该在它后面加一个反斜杠和一个空格。

您的反斜杠在点的错误一侧，并且手册必须按字面意思理解，这意味着反斜杠后面需要空格。

以下应该可以工作（没有花括号部分）：

const int myVar = 1;   //!< Doxygen very long brief.\ {← SPACE here!}
                       //!  Brief sentence two.

【讨论】：

【解决方案2】：

那我觉得你一定要明确，使用\brief命令。 doxygen 文档Documenting the code 说

简单的描述也有几种可能：

1.可以将 \brief 命令与上述注释块之一一起使用。该命令在段落的末尾结束，因此在空行之后进行详细说明。

这是一个例子：

/*! \brief Brief description. * Brief description continued. * * Detailed description starts here. */

您可能还需要将JAVADOC_AUTOBRIEF 设置为NO。如果您仍然有问题，请在myVar 之前而不是之后添加评论，看看您是否得到了所需的内容。

我希望这会有所帮助！

【讨论】：

嗨菲尔，我无法禁用自动简报。此外，//!<Comment 始终是简短的。添加简介没有帮助。你建议把它放在变量工作之前，但这会弄乱文件的样式。我真的猜这是一个错误:(

【解决方案3】：

反斜杠似乎在错误的一侧。这是正确方法的另一个示例：

const int myInt = 2;   //!< Brief description (e.g.\ using only a few words). Details follow.

【讨论】：