C++ 如何标记@ref引用的结束?

C++ 如何标记@ref引用的结束?,c++,documentation,doxygen,C++,Documentation,Doxygen,我使用doxGEN来编写C++代码,并为代码编写了大量的DOXEGON DOC。在一个地方,我在代码中创建了一个组列表,并希望它显示如下: :控制一切的模块 :作为从机的模块 我的文档源如下所示: -@ref CM:控制一切的模块 -@ref-SM:@CM的从属模块 但是,问题是:Doxygen似乎将引用名称读取为CM:,而不是CM,因此无法找到引用。所以,不知何故,我需要告诉Doxygen引用名称的结尾。(例如,如果我在使用Bash,并且想要回显一个后缀为“s”的变量字符串,我会使用ech

我使用doxGEN来编写C++代码,并为代码编写了大量的DOXEGON DOC。在一个地方,我在代码中创建了一个组列表,并希望它显示如下:

  • :控制一切的模块
  • :作为从机的模块
我的文档源如下所示:

-@ref CM:控制一切的模块
-@ref-SM:@CM的从属模块

但是,问题是:Doxygen似乎将引用名称读取为
CM:
,而不是
CM
,因此无法找到引用。所以,不知何故,我需要告诉Doxygen引用名称的结尾。(例如,如果我在使用Bash,并且想要回显一个后缀为“s”的变量字符串,我会使用
echo“${noon}s”

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

在下,Doxygen手册包括以下信息:

某些命令有一个或多个参数。每一个论点都有一定的局限性 范围:

  • 如果使用大括号,则参数为单个单词
  • 如果使用(圆)大括号,参数将一直延伸到 找到了该命令
  • 如果参数中使用了{curly}大括号 延伸至下一段。段落以空格分隔 行或段指示器
好的,这一切都很好,但是文档没有说,我也不知道,这些大括号应该放在哪里。仅仅围绕争论?围绕整个命令和参数?两者都不起作用,我也不能想出一个可行的替代方案


那么,如何指示Doxygen引用名称的结尾?如果答案是大括号,那么它们应该放在哪里?

您引用的Doxygen文档描述的是Doxygen文档的语法,而不是使用Doxygen解析的源代码

换句话说,如果在描述命令时使用大括号,则只需一个单词;等等

查看以下文件:

您还可以尝试零宽度字符是否会破坏单词识别:

@ref CM‌: the ...

这适用于Doxygen版本1.8.11:

\ref name "":

显然,空字符串会触发一个回退,以便在其前面使用name参数。

大括号用于符号约定,而不是分隔符。分隔符是空白/换行符。问题始终是使用什么作为“名称”的分隔符/结尾。
@ref CM‌: the ...
\ref name "":