我看到大多数用于注释C++函数的Doxygen文档都类似于:
或者XML等效的格式(大致上)。
但我大多数情况下会在代码中直接注释我的参数,像这样。
所有三个都在HTML文件中给出了相同的输出(除了中间那个,它没有指定输入/输出)。
我的问题是:有没有Doxygen、Visual Studio或其他环境的特性,我无法利用我的内联方法?我理解在代码本身中编写和阅读注释时存在个人偏好,并且不希望争论这些。我只对是否会错过Doxygen或其他环境功能或格式感兴趣。
/// a description of the function or method followed with comments, like so
/// @return true=success, false=error
/// @param[in] bar blah blah
/// @param[out] baz blah blah
/// @param[out] quux blah blah
/// @param[out] quuux blah blah
/// @param[out] quuuux blah blah
static bool foo_one( int *bar, int *baz, int *quux, int *quuux, int *quuuux );
或者XML等效的格式(大致上)。
/// a description of the function or method, followed by
/// <returns>true=success, false=error</returns>
/// <param name=bar>blah blah</param>
/// <param name=baz>blah blah</param>
/// <param name=quux>blah blah</param>
/// <param name=quuux>blah blah</param>
/// <param name=quuuux>blah blah</param>
static bool foo_two( int *bar, int *baz, int *quux, int *quuux, int *quuuux );
但我大多数情况下会在代码中直接注释我的参数,像这样。
/// a description of the function or method, followed by
/// @return true=success, false=error
static bool foo_three(
int *bar, ///< [in] blah blah
int *baz, ///< [out] blah blah
int *quux, ///< [out] blah blah
int *quuux, ///< [out] blah blah
int *quuuux ///< [out] blah blah
);
所有三个都在HTML文件中给出了相同的输出(除了中间那个,它没有指定输入/输出)。
我的问题是:有没有Doxygen、Visual Studio或其他环境的特性,我无法利用我的内联方法?我理解在代码本身中编写和阅读注释时存在个人偏好,并且不希望争论这些。我只对是否会错过Doxygen或其他环境功能或格式感兴趣。