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

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

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

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

Java

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

Q&A

解決済

1回答

8106閲覧

要約Javadocがありませんというエラーについて

yajata

総合スコア5

Javadoc

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

Java

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

0グッド

0クリップ

投稿2019/08/25 08:42

最近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 }

試したこと

「名前をセットする。」の「。」によって、最初の文を終了させたつもりです。
他には「名前をセットする.」という記載も行いましたが、同様のエラーが出ます。
私は見当違いな対処を行っているのでしょうか。

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

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

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

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

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

y_waiwai

2019/08/25 08:50

エラーメッセージは勝手な要約、翻訳せず、そのままの形で提示しましょう
yajata

2019/08/25 09:48

すいません。一応このメッセージが原文ママになっております。
退会済みユーザー

退会済みユーザー

2019/08/25 11:41

CheckStyle の日本語対応がされてないだけかと (プレアデスで表示を日本語にしてるってことじゃないよ) 1行目が . で終わる文であること(タグ除く)だとおもったが
guest

回答1

0

ベストアンサー

要約javadocとは一体何なのでしょうか

Summary Javadoc の和訳かと思います。

対応としては、

「名前を返します。」という要約文を入れたつもり

上記で、「javadocの最初の文には終了時がありません。」が出る以外は問題ないと思います。

私は見当違いな対処を行っているのでしょうか。

合っていると思います。あわてず確認してみてください。
原文は

period symbol at the end of first javadoc sentence

だと思いますが、eclipseのデフォルト設定だと「javadocの最初の文には終了時がありません。」となってますね。

periodの設定を変更していなければ、半角の.なので、

java

1/** 2 * 名前をセットする. 3 * @param newName セットする名前 4 **/

であれば、警告でないと思います。(少なくとも私の環境ではでない)

投稿2019/08/25 11:33

momon-ga

総合スコア4820

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

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

yajata

2019/08/25 12:51

なんとか解決しました。本当にありがとうございました。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.49%

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

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

質問する

関連した質問