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

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

新規登録して質問してみよう
ただいま回答率
85.51%
Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

Q&A

解決済

2回答

2971閲覧

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

退会済みユーザー

退会済みユーザー

総合スコア0

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

0グッド

0クリップ

投稿2015/07/25 05:41

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() { }

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

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

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

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

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

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

ベストアンサー

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

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

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

投稿2015/07/25 05:47

argius

総合スコア9388

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

退会済みユーザー

退会済みユーザー

2015/07/25 06:56

ご回答ありがとございます。 手順どおりにやったのですが(簡単な手順)、Java docができなかったので、 ちょっと、ソースのJava Doc を書き直してみます。 一応、ソース上では、関数名の上にカーソルを乗せると、 Java Doc画面が噴出しのように表示され、 情報もきちんと表示されるのですが。 どこかが悪いんだと思います。 見直してみます。
argius

2015/07/25 07:17

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

0

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

参考情報:

... クラス毎にメソッドの一覧、ソースファイル名、ソース行数を標準出力へ出力 ...

これは、doclet を使って メソッド一覧を excel ファイルに出力します。

投稿2015/07/25 23:41

katoy

総合スコア22322

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

退会済みユーザー

退会済みユーザー

2015/07/26 00:48

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.51%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問