如何標記@ref引用的結尾？

Question

我正在使用Doxygen來記錄C ++代碼，並為代碼編寫了大量的Doxygen doc。 在一個地方我在代碼中創建一個組列表，並希望它顯示如下：

• 控制模塊 ：控制一切的模塊
• 從站模塊 ：作為控制模塊從站的模塊

我的文檔源代碼如下：

- @ref CM：控制一切的模塊
- @ref SM：作為@CM的奴隸的模塊

但是，問題：Doxygen似乎是將參考名稱讀為CM: ,而不是CM ，因此無法找到參考。 所以，不知怎的，我需要告訴Doxygen參考名稱的結尾。 （例如，如果我使用Bash，並且想要回顯一個帶有“s”作為后綴的變量字符串，我會使用echo "${NOUN}s" 。）

作為一種解決方法，我可以在名稱和后續冒號之間添加一個空格，但這會使得生成的文檔更難以閱讀，我想避免它。

在特殊命令下 ，Doxygen手冊包含以下有希望的信息：

某些命令具有一個或多個參數。 每個參數都有一定的范圍：

• 如果使用<sharp>大括號，則參數是單個單詞。
• 如果使用（圓形）大括號，則參數將延伸到找到命令的行的末尾。
• 如果使用{curly}大括號，則參數將延伸到下一段。 段落由空行或部分指示符分隔。

OK，這就是優秀和良好，但文檔不說了，我想不通， 在這些括號應該去。 只圍繞論點？ 圍繞整個命令和論點？ 兩者都不起作用，我無法想出一個有效的替代方案。

那么，如何指示Doxygen參考名稱的結尾？ 如果支撐是答案，他們會去哪里？

Answer 1

這適用於Doxygen版本1.8.11：

\ref name "":

顯然，空字符串觸發回退以在其之前使用name參數。

Answer 2

您引用的Doxygen文檔描述了Doxygen文檔的語法，而不是您使用Doxygen要解析的源代碼 。

換句話說，如果在描述命令時使用<sharp>大括號，則只需一個單詞; 等等。

查看@ref的文檔：

 \\ref <name> ["(text)"] 

name參數是“尖銳的括號”，所以它只是一個單詞。 不幸的是，Doxygen似乎在解釋:作為這個詞的一部分。 你最好的選擇是引入一個空間：

@ref CM : the ...

您還可以嘗試零寬度字符是否會破壞單詞識別：

@ref CM‌: the ...