私は Visual Studio でのGhostDocの自動コメント生成の大ファンなので、Eclipse で私の Java コードと同じ仕事をするプラグインを探しています。推奨事項はありますか?
5 に答える
JAutodoc ( http://jautodoc.sourceforge.net/ )を確認できます
。著者から:
JAutodoc は、Javadoc とファイル ヘッダーをソース コードに自動的に追加するための Eclipse プラグインです。オプションで、Javadoc およびファイル ヘッダーの Velocity テンプレートを使用して、要素名から初期コメントを生成します。
これは、私が見つけた GhostDoc に最も近いものです。
これは基本的に、ショートカットを使用してEclipseで生成できるJavadocと同等です。
ALT+ Shift+J
(Javadoc を追加したい Java 関数内にいる場合)
そこから、本当に XML 形式が必要な場合は、JELDoclet を試して使用できます。
GhostDocには、メソッド名を解析し、これを骨格ドキュメントとして提供することで、メソッドの機能の説明を推測する優れた追加機能があります。たとえば、GetDocumentName()という名前のメソッドでGhostDocを使用すると、「ドキュメント名を取得する」というフレーズが返される場合があります。これはメソッド名で提供される情報よりも多くの情報ではありませんが、以前は存在しなかったメソッドのドキュメントを追加します。これはほとんど役に立たないと主張する人もいるかもしれません。ソースコードからのドキュメントの生成をサポートしているので(たとえば、NDocやSandCastleなどのツールの場合)、私は反対のことを主張します。
私の意見では、Eclipseの「GenerateElement Comment」に対するGhostDocの最大の利点は、非常に高速で信頼性の高い方法でこれを作成することにより、プログラマーがドキュメントのコメントを追加し始めることを奨励することです。プログラマーは、推測されたテキストを受け入れるか(50〜80%の場合に適しています)、これを拡張してより複雑なメソッドにすることができます。ドキュメントのコメントの使用方法に精通していないジュニアプログラマーにとって、これは学習曲線をすばやく短縮し、優れたプログラミング手法を促進することができます。
Javadoc は私の友人である GhostDoc とは異なります。Javadoc は構造を作成するだけなので、ドキュメントをゼロから作成できます。GhostDoc は、メソッド/プロパティ名に従って実際に情報を入力します。
例:
/// <summary>
/// Gets the user from id.
/// </summary>
/// <param name="id">The id.</param>
/// <returns></returns>
private string GetUserFromId(string id);
JAutoDocは私がこれまでに見つけた中で最も近いものですが、GhostDoc ほど魅力的ではありません。
GhostDoc を使用したことがないため、どのような追加機能が提供されるかはわかりませんが、名前、パラメーター、戻り値の型などに基づいて型とメソッドのコメントを生成する場合は、Eclipse に組み込まれているため、拡張機能は必要ありません。