2009-07-31 6 views
1

公開C++ヘッダーファイルには多くのコメントが必要です。 doxygenコメントを書式設定してラップするのは難しいです。いくつかの書式設定ツールがありますか?doxygenコードコメントを書くための最良のツールまたはテクニックは何ですか

80番目の文字に自動折り返し線などの機能があり、視覚的な機能のグループ化が容易です。理想的には、ドキュメンテーションライターはドキュメンテーションを個別に準備し、コードにdoxytagsを使用して挿入またはリンクします。

現時点では、私たちはメモ帳/ IDEを使用してコードを文書化しています。

答えて

3

あなたが作業しているIDEについては言及していません - Visual Studioで作業している場合は、アドイン(AtomineerUtils)を書いて、XML、DoxygenまたはJavaDocを生成/更新します。あなたのソースファイルにドキュメンテーションのコメントを書いたり、あなたの言い回しを整理して書式設定したりすることができます。また、コメントとコード(パラメータ、型パラメータ、スローされた例外など)を同期させます。

(Visual Studio 2010,2008,2005では、C、C++、C++/CLI、C#、Visual Basic、Javaをサポートしています)

+2

私は愛が大好きですAtomineerUtils –

+0

乾杯、エリック:-) –

関連する問題