Doxygen 默认注释

Question

是否可以在 Doxygen 中定义类似宏的东西？

我想写这样的评论：

/**
 \return return_self_reference
 */

Doxygen 将用我定义的字符串替换 return_self_reference。

随后 Doxygen 将读取的评论是：

/**
 \return A reference to the instance that the operator was called on.
 */

请注意，虽然我之前称它为宏，但我不想在实际代码中定义 C 宏或类似的东西。

Answer 1

对于这些情况，Doxygen 具有配置参数 ALIASES。

举个例子：

/** \file
  */


/**
 * \return the normal version
 */
int fie0(void);

/**
 * \return \str1_repl
 */
int fie1(void);

/**
 * \str2_repl
 */
int fie2(void);

并在doxygen配置文件中设置如下ALIASES（更多可能的ALIASES参见手册）：

ALIASES                = "str1_repl=just the text in replacement" \
                         "str2_repl=\return return and the text in replacement"

我们将得到以下结果：

Doxygen 默认注释

Doxygen default comments

documentation

doxygen

documentation-generation

code-documentation