我们使用 doxygen 来记录我们刚刚开始的项目中的 C/C++ 代码,如果可能的话,我们希望实现以下目标。
创建带有多个参数的自定义 ALIAS 时,我们在代码文档中使用的语法如下所示:
/**
* @myalias{param1,param2}
*/
在我们的 .doxy 文件中,这个 ALIAS 的定义看起来像:
ALIASES += myalias{2}="do something with \1 and with \2"
我们想要的是定义一个自定义标签,它的行为类似于@param,这将允许我们在记录我们的源文件时使用以下语法:
/**
* @myalias param1 param2
*/
并且仍然能够以某种方式引用 param1 和 param2。
我知道,例如,@param 标签可以将 param1 和 param2 区分为 2 个不同的实体,并且它不需要任何花括号。
是否可以定义一个自定义标记,在其中我们可以在 .doxy 文件中将 param1 和 param2 作为单独的实体访问,但是通过使用没有花括号的代码文档语法?
先感谢您
最佳答案
最简洁的答案是不。在非常仔细地阅读 doxygen 文档后,似乎确实有一个合理的解释。内置的 doxygen 命令列表可能会发生变化,并且您不希望在更改时重新定义所有别名。发生冲突时,您将如何选择命令与别名?不必执行决定,doxygen 会强制您指明哪个是哪个。
文档中隐含的示例在 aliases with arguments 部分中.在这里,l{1}
别名被详细定义和试验。但是,如果你去the bottom of the list of commands ,它明确指出有一个命令 \l
永远不应该明确使用。花括号别名定义使其完全明确使用的是哪个。
我不确定这是否真的是一种深思熟虑的设计理念,或者只是很高兴地以这种方式结合在一起,但这种区别是有用的。
我很抱歉写这个答案,因为我自己希望你想要达到的结果。知道原因会有所帮助。
关于documentation - DOXYGEN:创建没有花括号语法的多参数别名,如@param 和其他人(标签!)?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24970788/