gpt4 book ai didi

c++ - 如何标记@ref 引用的结尾?

转载 作者:塔克拉玛干 更新时间:2023-11-03 01:51:39 24 4
gpt4 key购买 nike

我正在使用 Doxygen 来记录 C++ 代码,并且正在为代码编写大量的 Doxygen 文档。在一个地方,我在代码中制作了一个组列表,并希望它显示如下:

我的文档源是这样的:

- @ref CM: the module that controls everything
- @ref SM: the module that is the slave of the @CM

但是,问题:Doxygen 似乎将引用名称读取为 CM:,而不是 CM,因此无法找到引用。所以,我需要以某种方式告诉 Doxygen 引用名称结束的位置。 (例如,如果我使用 Bash,并且想要回显一个以“s”作为后缀的变量字符串,我会使用 echo "${NOUN}s"。)

作为一种解决方法,我可以在名称和随后的冒号之间添加一个空格,但这会使生成的文档更难阅读,我想避免使用它。

Special Commands , Doxygen 手册包含以下听起来充满希望的信息:

Some commands have one or more arguments. Each argument has a certain range:

  • If <sharp> braces are used the argument is a single word.
  • If (round) braces are used the argument extends until the end of the line on which the command was found.
  • If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.

好的,这一切都很好,但文档没有说明,而且我无法弄清楚,这些大括号应该放在哪里。独自围绕争论?围绕整个命令和论点?两者都不起作用,而且我想不出一个可行的替代方案。

那么,如何指示 Doxygen 的引用名称的结尾?如果牙套是答案,它们去哪儿了?

最佳答案

这适用于 Doxygen 版本 1.8.11:

\ref name "":

显然,空字符串会触发回退以使用它之前的名称参数。

关于c++ - 如何标记@ref 引用的结尾?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36310223/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com