Java のコード ドキュメントを作成するための適切な無料のプログラムはありますか?コーディング プロジェクトを完了するのは非常に難しく、ドキュメントの作成にも時間を費やす必要があります。ご存知でしたら教えてください。
4491 次
6 に答える
16
javadocは、Java ソース コード ドキュメント用の標準ツール (JDK に含まれています) です。
標準のJava API ドキュメントは、javadoc で生成されています。
于 2009-09-30T11:34:46.547 に答える
3
良い、
間違いなくjavadocがあります。これは、Java プロジェクトの文書化に最もよく使用されるツールだと思います。また、メソッドとクラスを文書化するだけでなく、静的な html ページを使用してチュートリアルを文書化/作成することもでき、それらは生成された文書に表示されることを考慮してください。
于 2009-09-30T11:36:58.173 に答える
1
最も一般的な IDE (Eclipse、NetBeans など) はすべて、javadoc を生成します。すべてのパラメーター、スローされた例外などをリストします。getter や setter などの明白な目的のメソッドについては、十分なコメント (getX() "Gets x" など) も生成します。さらに必要なことは、getter、setter、またはデフォルトのコンストラクターよりも洗練されたクラスとメソッドの javadoc コメントを完成させることです。
コード構造を説明する UML ダイアグラムの生成などに使用できるプラグインも多数あります (Eclipse の場合はこちらを参照)。
于 2009-09-30T12:05:00.293 に答える
1
Javadoc (前述のとおり) は、Java の標準ツールです。ただし、より強力なコード ナビゲーション機能とレンダリング オプションを提供するDoxygenを確認することをお勧めします。
于 2009-09-30T11:37:36.870 に答える
0
何年もの間 (10 年以上)、私は TallTree の DocJet ( http://www.talltree.com/ ) を使用して、Java/C++ コードから技術文書を生成し、非常に満足のいく結果を得ています。このツールは特別なタグを必要としません (ただし、javadoc タグを認識します)。クラス/メソッド/フィールドを平易な英語で記述し、「リターン」(または同じ意味を持つ他の表現)、「パラメータ」、「引数」などの言葉を時折使用するだけで十分です。
于 2009-11-30T14:42:36.987 に答える
0
自動生成されたドキュメントは最悪です。なぜそれを持っているのですか？付加価値はありません。
于 2009-09-30T11:44:35.623 に答える