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

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

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

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

Java

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

解決済

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

yajata
yajata

総合スコア5

Javadoc

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

Java

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

1回答

0評価

0クリップ

2043閲覧

投稿2019/08/25 08:42

最近javaを学び始めたものです。
CheckStyle(Google Checks)を用いながらソースコードを書いているのですが、Javadocに関する以下の2つのエラーを解決出来なくて悩んでます。
調べても解決方法が分かりませんでした。

①要約javadocがありません。

getterメソッドを記述し、Javadocを挿入したのですが、
「要約javadocがありません。」
というCheckStyleのエラーが出ます。
以下がソースコードになります。

該当のソースコード

java

/** * 名前を返します。 * @return name 名前. * */ public String getName() { return this.name; }

試したこと

「名前を返します。」という要約文を入れたつもりなのですが、このようなエラーが出ます。
要約javadocとは一体何なのでしょうか。調べても出てこず、手詰まり状態になっています。

②javadocの最初の文には終了時がありません。

以下のソースコードを書きましたが、「javadocの最初の文には終了時がありません。」 というCheckStyleエラー文が出ます。 

該当のソースコード

java

/** *名前をセットする。 *@param newName セットする名前 **/ public void setName(String newName) { if (newName.length() < 3) { throw new IllegalArgumentException("名前が不正です"); } this.name = newName; }

試したこと

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

良い質問の評価を上げる

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

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

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

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

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

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

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

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

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

y_waiwai

2019/08/25 08:50

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

2019/08/25 09:48

すいません。一応このメッセージが原文ママになっております。
asahina1979

2019/08/25 11:41

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

まだ回答がついていません

会員登録して回答してみよう

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

ただいまの回答率
87.20%

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

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

質問する

関連した質問

同じタグがついた質問を見る

Javadoc

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

Java

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