我有一个函数的以下Doxygen文档：
/**
@brief Does interesting things
@param[in] pfirst The first parameter: a barrel full of monkeys
@pre
"pfirst" must have been previously passed through BarrelFiller()
*/
注意pfirst是一个参数，并且它在前置条件中被引用。
我在这里用引号括起来是因为我想将其与文本的其余部分区分开。但如果能以这种方式做到Doxygen将突出显示命令并最好将其链接到参数定义，那就更好了。是否有方法可以实现这一点？
最好只使用默认配置（或稍作修改）即可实现此目的。
我知道你在询问@param参数，但谷歌搜索也会将@return类型的问题带到这里，所以这里也提供一下答案：
#在返回值前创建超链接到其定义：使用#符号。
完整示例（请查看下面带有#的@return类型）：
#include <stdarg.h> // for va_list, va_start, va_end
#include <stdio.h> // for vsnprintf
// Function prototype:
int debug_printf(const char *format, ...) __attribute__((format(printf, 1, 2)));
// Function definition:
/// @brief Function to print out data through serial UART for debugging.
/// @details Feel free to add more details here,
/// perhaps
/// even
/// a
/// whole
/// paragraph.
/// @note Optionally add a note too.
/// @param[in] format `printf`-like format string
/// @param[in] ... `printf`-like variadic list of arguments corresponding
/// to the format string
/// @return Number of characters printed if OK, or < 0 if error:
/// - #DEBUG_ERR_ENCODING
/// - #DEBUG_ERR_OVERFLOW
/// - #DEBUG_ERR_UART
int debug_printf(const char *format, ...)
{
int num_chars_printed;
va_list args;
va_start(args, format);
// Use `vsnprintf()` now here to format everything into a single string
// buffer, then send out over the UART
// - num_chars_printed could be set to one of the error codes listed above
// here
va_end(args);
return num_chars_printed;
}
Number of characters printed if OK, or < 0 if error:下，每个错误类型因其前面的#字符而转化为其各自定义的URL。
\brief或@brief、\note或@note、\details或@details、\example等）。param值为param[in]、param[in,out]和param[out]。更多细节和官方文档请参见以下引用：
param特殊命令的官方Doxygen文档：http://www.doxygen.nl/manual/commands.html#cmdparamprintf基本包装器实现：https://github.com/adafruit/ArduinoCore-samd/blob/master/cores/arduino/Print.cpp#L189完整的Doxygen函数头示例：
/// \brief A brief one or two line description of the function.
/// \note An important note the user should be aware of--perhaps many
/// lines.
/// \details Extra details.
/// Perhaps
/// even
/// a long
/// paragraph.
/// \param[in] var1 Description of variable one, an input
/// \param[in] var2 Description of variable two, an input
/// \param[out] var3 Description of variable three, an output
/// (usu. via a pointer to a variable)
/// \param[in,out] var4 Description of variable four, an
/// input/output (usu. via a pointer) since its initial
/// value is read and used, but then it is also updated by
/// the function at some point
/// \return Description of return types. It may be an enum, with these
/// possible values:
/// - #ENUM_VALUE_1
/// - #ENUM_VALUE_2
/// - #ENUM_VALUE_3
my_enum_t myFunc(int var1, int var2, int* var3, int* var4)
{
// function implementation here
my_enum_t error = ENUM_VALUE_1;
// Check for NULL pointers
if (!var3 || !var4)
{
// var3 or var4 are NULL pointers, which means they can't be
// dereferenced
error = ENUM_VALUE_2;
goto done;
}
if (something_else)
{
error = ENUM_VALUE_3;
goto done;
}
done:
return error;
}
@代替\：/// @brief A brief one or two line description of the function.
/// @param[in] var1 Description of variable one, an input
/// @param[in] var2 Description of variable two, an input
/// @param[out] var3 Description of variable three, an output
/// (usu. via a pointer to a variable)
/// @param[in,out] var4 Description of variable four, an
/// input/output (usu. via a pointer) since its initial
/// value is read and used, but then it is also updated by
/// the function at some point
/// @return None
void myFunc(int var1, int var2, int* var3, int* var4)
{
// function implementation here
}
这里是较短的版本，现在又回到了使用\而不是@的方式:
/// \brief A brief one or two line description of the function.
/// \param[in] var1 Description of variable one, an input
/// \param[in] var2 Description of variable two, an input
/// \param[out] var3 Description of variable three, an output (
/// usu. via a pointer to a variable)
/// \param[in,out] var4 Description of variable four, an
/// input/output (usu. via a pointer) since its initial
/// value is read and used, but then it is also updated by
/// the function at some point
/// \return None
void myFunc(int var1, int var2, int* var3, int* var4)
{
// function implementation here
}
# 用于指代成员变量，而不是函数参数。 - xuhdevpfirst是一个参数，这会产生一个“警告：无法解析对pfirst的显式链接请求”，并且哈希将按字面意义写入生成的文档中。如果pfirst是成员函数或变量，则输出是一个漂亮的链接。 - Stein@return 类型（值）前面使用 # 符号可以创建到每个返回值定义的链接，这正是我想知道的。例如：/// @return 打印的字符数，如果出错则为 <0：#OVERFLOW 或 #UART。现在，在我的生成的 Doxygen 中，“OVERFLOW”和“UART”显示为超链接到它们各自的定义，这非常好。 - Gabriel Staples
\替换为@，从而获得相同的结果。因此，@p在这里也适用。 - underscore_d