最近javaを学び始めたものです。
CheckStyle(Google Checks)を用いながらソースコードを書いているのですが、Javadocに関する以下の2つのエラーを解決出来なくて悩んでます。
調べても解決方法が分かりませんでした。
①要約javadocがありません。
getterメソッドを記述し、Javadocを挿入したのですが、
「要約javadocがありません。」
というCheckStyleのエラーが出ます。
以下がソースコードになります。
該当のソースコード
java
1 /** 2 * 名前を返します。 3 * @return name 名前. 4 * 5 */ 6 public String getName() { 7 return this.name; 8 }
試したこと
「名前を返します。」という要約文を入れたつもりなのですが、このようなエラーが出ます。
要約javadocとは一体何なのでしょうか。調べても出てこず、手詰まり状態になっています。
②javadocの最初の文には終了時がありません。
以下のソースコードを書きましたが、「javadocの最初の文には終了時がありません。」 というCheckStyleエラー文が出ます。
該当のソースコード
java
1 /** 2 *名前をセットする。 3 *@param newName セットする名前 4 **/ 5 public void setName(String newName) { 6 if (newName.length() < 3) { 7 throw new IllegalArgumentException("名前が不正です"); 8 } 9 this.name = newName; 10 }
試したこと
「名前をセットする。」の「。」によって、最初の文を終了させたつもりです。
他には「名前をセットする.」という記載も行いましたが、同様のエラーが出ます。
私は見当違いな対処を行っているのでしょうか。
回答1件
あなたの回答
tips
プレビュー