时间戳

首页 > 解决方案 > 我可以在 doxygen @ref 中使用反引号和括号吗？

comments - 我可以在 doxygen @ref 中使用反引号和括号吗？

问题描述

我想在我的 C++ 代码中使用 doxygen 注释来引用某个函数；比如说，在不同的命名空间中：foo::bar(). 并且让我们忽略这个函数被重载的可能性。而且我还希望将函数的名称设置为与我的 doxygen 注释中反引号中的内容相同的方式。

考虑到这一点，以下哪项应该会产生我所描述的效果？

@ref foo::bar
@ref foo::bar()
@ref `foo::bar`
@ref `foo::bar()`

或者——也许是别的东西？

标签： commentsdoxygencode-documentationcross-referencebackticks

解决方案

该\ref命令的文档指出：

\ref ["(文本)"]

创建对命名节、子节、页面或锚点的引用。对于 HTML 文档，参考命令将生成该部分的链接。对于节或小节，节的标题将用作链接的文本。对于锚点，将使用引号之间的可选文本，或者如果没有指定文本。对于 LATEX 文档，reference 命令将生成节的节号，如果引用锚点，则生成后跟页码的文本。

该\ref命令的第一个参数是 the <name>，并且 a<name>不能包含反引号。

为了获得请求的单间距链接的可能性，可以为 HTML（仅限！）调整/扩展样式表中使用的条目。

首先：
在默认的 doxygen 样式表doxygen.css中，我们有：

a.el {
        font-weight: bold;
}

通过将此条目更改为例如

a.el {
        font-family: monospace, fixed;
        font-weight: normal;
}

最好不要重新定义doxygen.css并将其作为设置HTML_STYLESHEET，而是创建一个新的额外样式表并在HTML_EXTRA_STYLESHEET.

请注意，这将影响所有链接，而不仅仅是\ref那些链接。

推荐阅读