Question

我有这个示例代码。我在简短的评论中想要一个点。

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

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

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

Answer 1

doxygen manual说

如果启用此选项并想在句子中间放置一个点而不结束它，则应在其后面添加反斜杠和空格。

你的反斜杠是在点的错误一侧，手册必须按字面意思进行，这意味着在反斜杠后需要空格。

以下应该有效（没有花括号部分）：

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

Answer 2

然后我认为你必须明确并使用\brief命令。 doxygen文档Documenting the code说

简要说明还有几种可能性：

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

以下是一个例子：

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

您可能还需要将JAVADOC_AUTOBRIEF设置为NO。如果您仍然遇到问题，请先查看评论，而不是myVar之后，看看您是否得到了您想要的内容。

我希望这有帮助！

将点放在简要说明中

2 个答案: