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

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

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

Javadocは、Java言語で記述されたクラスライブラリ、及びアプリケーションについてのパッケージ・クラス・メソッドのHTML形式のAPI仕様書のことを指します。ドキュメント更新の漏れを減らすことができ、最新の状態を把握することが可能になります。

Java

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

Q&A

解決済

1回答

10921閲覧

Enumのjavadocについて教えてください。

yurishi

総合スコア7

Javadoc

Javadocは、Java言語で記述されたクラスライブラリ、及びアプリケーションについてのパッケージ・クラス・メソッドのHTML形式のAPI仕様書のことを指します。ドキュメント更新の漏れを減らすことができ、最新の状態を把握することが可能になります。

Java

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

0グッド

0クリップ

投稿2016/09/11 00:34

いつもお世話になっております。
javaを勉強し始めて3カ月の初心者です。

現在、課題でJSP、サーブレットを利用してのアプリ作成を行っております。

その中でコード値を利用するために、列挙型のEnumを使用しているのですが、作成したEnumクラスにjavadocコメントをつけて下さいとの指摘を受け、手が止まってしまっております。
Enumクラスのフィールドコメントとメソッドコメントに何と書けば適切なjavadocの記載となるのか分かりません。

下記、対象クラスのコードです。

public enum Color {
RED(1, "赤"),
GREEN(2,"緑"),
BLUE(3, "青");
private int code;
private String display;
Color(int code, String display) {
this.code = code;
this.display = display;
}

public int getCode() { return this.code; } public void setCode(int code) { this.code = code; } public String getDisplay() { return this.display; } public void setName(String display) { this.display = display; } public static String valueOf(int code) { String display = ""; for (Color color : Color.values()) { if (color.getCode() == code) { display = color.getDisplay(); break; } } return display; }

}

ご教授いただけませんでしょうか。

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

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

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

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

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

guest

回答1

0

ベストアンサー

実際にライブラリのJavadocを見てみると良いのではないでしょうか?
Enumでぱっと思いついたのは→DayOfWeek
基本的にそのフィールドが何を意味し、Enum定数が何を意味し、メソッドがどういうことをしてどういう値を返すのかを記述すれば良いのではないでしょうか?

蛇足ですが、Enum定数が持っているフィールドが書き換えられるのが違和感あります…

投稿2016/09/11 02:04

swordone

総合スコア20669

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

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.37%

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

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

質問する

関連した質問