質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.03%

eclipsのJavaソース内のJAVA DOCから、「// 関数():関数の説明」をリストアップしたい

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 2,315
退会済みユーザー

退会済みユーザー

eclipsでJavaソースを書き始めてまだ、2ヶ月くらいの超ド新人です。

JAVA DOCを書くように言われ、10数行の情報を書いています。
下記のような感じで。

    // -------------------------------------------------------------
    /**
     *
     * @see functin:
     * @see DBープン
     *
     * @author Mio
     * @since  2015-05-01
     *
     * @param Nothing
     *
     * @return {@code true:成功}
     * @return {@code false:失敗}
     *
     * @exception RuntimeException
     *
     */
    public boolean open() {
        }

上記せかっく書いてあるのだだから、
このクラス内のメソッドは何があるかな?と後継者や他人が見たときに
一目でわかるように、

ソースファイルの一番先頭に、下記のような一覧を作りたいのですが、
自動で作る方法、もしくは、作る元の材料になる情報を取り出す方法は、
ありませんか?

引き継いだ後に、後継人が、いちいち、ソースを検索したり、
何がこのクラスでできるのか(どんな関数が用意していあるのか)を
一目でわかるようにする為です。※特別な操作をせずに。

// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明
// 関数():関数の説明

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+4

ドキュメンテーションコメントは、その情報を元にクラスのサマリー(Javadoc)を自動生成してくれるためのものなので、わざわざ自分で作ってしまうと二度手間になってしまうと思います。


下記リンク先ページを参考にしてJavadocを作ってみてください。

クラウドサービスプラットフォーム Cosminexus:EclipseからJavadocを生成するには?:ソフトウェア:日立

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/07/25 15:56

    ご回答ありがとございます。
    手順どおりにやったのですが(簡単な手順)、Java docができなかったので、
    ちょっと、ソースのJava Doc を書き直してみます。

    一応、ソース上では、関数名の上にカーソルを乗せると、
    Java Doc画面が噴出しのように表示され、
    情報もきちんと表示されるのですが。

    どこかが悪いんだと思います。
    見直してみます。

    キャンセル

  • 2015/07/25 16:17

    デフォルトでは、要素のアクセス修飾子がpublicのものだけが対象になっていたと思います。protectedやprivateも出力したい場合は、そのパラメーター(手元の環境では「次の可視性を持つメンバーのJavadocを生成」という項目です)を変更すればOKです。

    キャンセル

0

ソースコードにメソッド一覧を埋め込んでしますと、ソースの更新と、その一覧がずれていってしまう可能性がありそうです。
でも make や ant で 別ファイルに一覧をつくるようにすれば 常に最新の一覧表を得ることができるとおもいます。

参考情報:
- メソッド一覧を得る方法 http://blog.mesh.cx/2010/05/blog-post.html

- カスタムドックレットを作る http://d.hatena.ne.jp/tanamon/20090402/1238646762
... クラス毎にメソッドの一覧、ソースファイル名、ソース行数を標準出力へ出力 ...

- JavaDoc 2 Excel is a Document builder written in Java.  http://www.sepia.dti.ne.jp/yonsama/JavaDoc2Excel.html
これは、doclet を使って メソッド一覧を excel ファイルに出力します。

- カスタムDocletでJavadoc情報をCSV出力 http://argius.hatenablog.jp/entry/2014/01/07/222423

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/07/26 09:48

    ご回答ありがとうございます。
    さっそく、そのページをみてみます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.03%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る