【发布时间】:2021-02-24 22:31:06
【问题描述】:
我想在我的 C++ 代码中使用 doxygen 注释来引用某个函数;比如说,在不同的命名空间中:foo::bar()。并且让我们忽略这个函数被重载的可能性。而且我还希望函数名称的设置方式与我的 doxygen cmets 中反引号内的内容相同。
考虑到这一点,以下哪项应该会产生我所描述的效果?
@ref foo::bar
@ref foo::bar()
@ref `foo::bar`
@ref `foo::bar()`
或者——也许是别的什么?
【问题讨论】:
-
"我应该使用以下哪个?"是基于我的想法。有什么作用?什么没有?哪个版本的 doxygen。
-
@albert:澄清我想知道其中哪些应该起作用。
-
好吧,最后 2 个发出警告,因为它们不包含有效标签。
-
@albert:但是前两个不是导致链接文本不是等宽的吗?
-
它们具有 doxygen.css 文件中定义的字母类型/样式。请参阅 doxygen.css 中的
a.el(在我的情况下是第 216 行)。
标签: comments doxygen code-documentation cross-reference backticks