32

Javadoc のない大きなコードベースがあり、プログラムを実行して基本的な Javadoc 情報 (たとえば、各メソッドのパラメーター write @param...) を含むスケルトンを作成したいので、残っているギャップを埋める必要があります。

これに対する良い解決策を知っている人はいますか？

編集：

JAutodoc は私が探していたものです。Eclipse プラグインである Ant タスクがあり、テンプレート定義に Velocity を使用します。

4

6 に答える 6

39

Eclipse 用のJAutodocプラグインはまさに必要なことを行いますが、パッケージの粒度は次のとおりです。

パッケージを右クリックし、「メンバに javadoc を追加...」を選択すると、スケルトンが追加されます。

多数の興味深いオプションがあります。javadoc のテンプレート、すべてのファイルのヘッダーに TODO を追加して、「テンプレート javadoc、入力する必要があります...」などです。

于 2008-08-28T10:02:10.887 に答える
23

空の Javadoc を自動生成することはアンチパターンであり、お勧めできません。コードは文書化されているように見えますが、コードベースにノイズが追加されるだけです。

代わりに、実際に javadoc を作成するときに使用するメソッドごとおよびクラスごとに支援するようにコード エディターを構成することをお勧めします (1 人のコメンターが、これを行う Eclipse の機能を指摘しました)。

于 2008-09-15T16:35:34.723 に答える
13

JavaDoc を作成するメソッドの上の行にカーソルを置き、次のように入力することもできます。

/**

し、Enter を押します。これにより、JavaDoc スタブが生成されます。

于 2013-05-09T22:37:21.600 に答える
4

Javadoc を追加するメソッドを選択するaltと、 + Shift+ j、自動的に javadoc コメントが作成されます。

例：

/**
     * @param currDate
     * @param index
     * @return
     */
    public static String getAtoBinary(String currDate, int index){  
        String HourA = "0";
        try{
            String[] mydate = currDate.split("/");
            HourA = mydate[index].substring(1, 2);
        }catch(Exception e){
            Log.e(TAG, e.getMessage());
        }
        return HourA;
    }
于 2014-08-28T21:32:36.203 に答える
4

eclipse を構成して、javadoc が不足しているもの、または javadoc にすべての情報が含まれていないもの、または間違った情報があるものに対して警告を表示することができます。テンプレートを挿入して入力することもできます。

あなたが求めていたツールとはまったく異なりますが、見逃したメソッドの空のスケルトンになってしまうことがないため、おそらくより良いでしょう。

これを行うには、ワークスペースの [ウィンドウ] > [設定] > [Java] > [コンパイラ] > [Javadoc] のパスの先にある設定ページを調査して編集します。その設定ページのスクリーンショットは次のとおりです。

いわゆる Javadoc 設定ページ

この画面の項目の詳細については、次のリンクを参照してください。

Java コンパイラ Javadoc 設定ヘルプ

于 2008-08-28T10:06:34.870 に答える
2

Eclipse でファイルのソースを右クリックすると、ソース メニューの下に Javadoc 生成オプションがあります。

于 2008-08-27T08:05:52.250 に答える