Doxygenにインラインでコメントを付けるには何らかのペナルティが伴いますか？

Question

は私が

/// 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); 

に似て何かを探して、C++の関数をコメントするために最もDoxygenのドキュメントを参照してくださいが、私はほとんどそう

のように、インライン私のパラメータをコメントしてきました

/// 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 
); 

これらの3つはすべて、htmlファイル内で同じ出力を示します（中間のものを除きますが、 /でる）。

私の質問：Doxygen、Visual Studio、または私のインラインアプローチで利用できないその他の環境の機能はありますか？私は、コード自体にコメントを書いたり読んだりする際に個人的な好みがあり、それを議論したくないと思っています。私はDoxygenやその他の環境機能や書式設定があるかどうかを知ることにのみ関心があります。

Answer 1

はい。

Doxygen自体は、インラインコメントでうまく動作します。

しかしながら、ソース・コード・コントロール（例えば、git、及びgit blame）システムによって記録された履歴に及ぼす影響を検討

インラインコメント、ラインを変更最後の人は、追加またはドキュメントを変更誰でありますなぜコード自体が変更されたのかを見つけるのが難しくなります。

別々の行にコメントを付けると、特にコードの後に​​ドキュメントが追加された場合、履歴を調べてコードを変更する方が簡単です。