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

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

ただいまの
回答率

90.12%

Javadocの警告が消えなくて困っています

受付中

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 4,525

前提・実現したいこと

Javadocで適切に列挙型の説明をしたい。
Windows10
JDK1.7.0_79
JRE7

発生している問題・エラーメッセージ

コンパイルにて警告が出ます。
警告なので無視してもいいのですが、Javadocコメントは適切に書いているのに何故かコメントなしと書かれてしまい、疑問が尽きません。

src¥CalcType.java:18: 警告: コメントなし
          ADD("+"){
          ^

src¥CalcType.java:33: 警告: コメントなし
          SUB("-"){
          ^

src¥CalcType.java:48: 警告: コメントなし
          MUL("*"){
          ^

src¥CalcType.java:63: 警告: コメントなし
          DIV("/"){
          ^

src¥CalcType.java:78: 警告: コメントなし
          REM("%"){
          ^

src¥CalcType.java:93: 警告: コメントなし
          EXP("**"){
          ^

該当のソースコード

/*
 * CalcType.java
 */
package src;

/**
 * 演算子を管理する列挙型です
 * @author AUTHOR
 * @version 1.0.0
 */
public enum CalcType implements BinaryOperator{

    /**
     * 足し算を指すenum値です
     */
    ADD("+"){
        /**
         * 2つの引数の足すメソッドです
         * @param left 足される値
         * @param right 足す値
         * @return 計算結果
         */
        public final int operate(int left, int right){
            return left + right;
        }
    },

    /**
     * 引き算を指すenum値です
     */
    SUB("-"){
        /**
         * 2つの引数の差を求めるメソッドです
         * @param left 引かれる値
         * @param right 引く値
         * @return 計算結果
         */
        public final int operate(int left, int right){
            return left - right;
        }
    },

    /**
     * 掛け算を指すenum値です
     */
    MUL("*"){
        /**
         * 2つの引数の積を求めるメソッドです
         * @param left 掛けられる値
         * @param right 掛ける値
         * @return 計算結果
         */
        public final int operate(int left, int right){
            return left * right;
        }
    },

    /**
     * 割り算を指すenum値です
     */
    DIV("/"){
        /**
         * 2つの引数の商を求めるメソッドです
         * @param left 割られる値
         * @param right 割る値
         * @return 計算結果
         */
        public final int operate(int left, int right){
            return left / right;
        }
    },

    /**
     * 剰余計算を指すenum値です
     */
    REM("%"){
        /**
         * 2つの引数の剰余を求めるメソッドです
         * @param left 割られる値
         * @param right 割る値
         * @return 計算結果
         */
        public final int operate(int left, int right){
            return left % right;
        }
    },

    /**
     * 累乗計算を指すenum値です
     */
    EXP("**"){
        /**
         * 2つの引数の累乗を求めるメソッドです
         * @param left 元の値
         * @param right 掛ける回数
         * @return 計算結果
         */
        public final int operate(int left, int right){
            int ans = 1;
            for(int i = 0; i < right; ans *= left, i++){}
            return ans;
        }
    };

    /** 使用者の用いる演算子 */
    private final String name;

    /**
     * このenumのコンストラクタです
     * @param name 使用者の用いる演算子
     */ 
    private CalcType(String name){
        this.name = name;
    }

    /**
     * 使用者の用いる演算子に対応したenum値を返すメソッド
     * @param name 使用者の用いる演算子
     * @return 対応するenum値
     */

    public static final CalcType getType(String name){
        for(CalcType c : CalcType.values()){
            if(c.name.equals(name)){
                return c;
            }
        }
        return null;
    }

    /**
     * enum値が必ず計算メソッドを実装するための抽象メソッド
     * @param left 計算される値
     * @param right 計算する値
     * @return 計算結果
     */
    public abstract int operate(int left, int right);
}

試したこと

@paramでnameの説明をしようとした。
→それはエラーになり、結果としてエラーは増えた。
@authorや@versionを入力した
→変わらず

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 1

0

下記のコンストラクタに渡している"+"に説明を付けろってことでしょうかね。

ADD("+")

投稿

編集

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2016/12/15 23:57

    回答ありがとうございます!

    おそらくその通りだとは思うのですが、どのようにコメントすればよろしいですかね?汗

    @paramは何故かエラーになってしまったので…

    キャンセル

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

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