私たちは、Doxygen を導入して、大規模な C++ プロジェクトでより標準化されたコメントに向けてゆっくりと進んでいます。特にJava IDEはこれを自動化するのに非常に優れているため、個人的にコメントを入力するのは面倒です。
それで、どんなツールがあるのだろうと思いましたか？検索すると、非常に見栄えの良いDoxyCommentが見つかりました。これは最適な標準ツールですか、それとも他にも一見の価値があるツールはありますか?
2 に答える
1
doxygen への指示であるメタコメントを入力することがコメント作成作業の重要な部分である場合、それは間違っています。
コメントには、ツールによって自動的に決定できるものを含めるべきではありません。どのプログラマーも、ツールと同じくらい (またはそれ以上) の情報をパラメーター名などから決定します。
これを別の見方で見ると、doxygen はすでに、自動的に決定できるものを提示する優れた仕事をしているということです。「B::B は B オブジェクトを構築します」と書く必要はありません。これは、doxygen がドキュメントのコンストラクター セクションに自動的にソートするためです。
自明ではないことに焦点を当て、時間をかけて自分が書いていることについて考えてください。
通常、多くの関数と変数は個別のコメントを必要としません。これは、名前が十分に説明的であるか、複数のメンバーがどのように相互作用するかを説明するクラスレベルのコメントでより適切に説明されているためです。
于 2011-04-07T02:27:35.430 に答える
1
Atomineer は、Doxygen マークアップを使用してアンマネージ C++ コードを文書化するために、私と他の数人が使用しているツールです。無料ではありませんが、安価であり、試してみる価値があるかもしれません: http://www.atomineerutils.com/products.php
于 2011-04-07T02:21:00.230 に答える