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

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

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

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

Java

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

Q&A

解決済

1回答

1419閲覧

SonerLintの情報で表示される青波線を解決したい

King_of_Flies

総合スコア382

Javadoc

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

Java

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

0グッド

0クリップ

投稿2018/06/29 02:11

編集2018/06/29 02:27

以下メッセージを確認しました。

Public types, methods and fields (API) should be documented with Javadoc (squid:UndocumentedApi)

Google翻訳すると下記になります。

公開型、メソッド、およびフィールド(API)は、Javadoc(squid:UndocumentedApi)で文書化する必要があります。

javadocの文書化はどのように行えばよいのか、教えて下さい。
Spring Frameworkです。

java

1import java.util.List 2/** 3 * HogeRepositoryクラス 4 */ 5public interface HogeRepository { 6 7 /** 8 * 業務日付が適用開始日付~適用終了日付のデータを検索する。 9 * @param criteria 検索条件 10 * @return 業務日付が適用開始日付~適用終了日付のデータを返却する 11 */ 12 List<HogeResult> findByGyomuDate(String gyomuDate); 13} 14

青波線が表示される個所は"findGyomuDate"の箇所です。

よろしくお願いいたします。

追記
クラスはpackeageされており、
その同packeage内にはpackage-info.javaも作成されています。

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

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

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

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

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

guest

回答1

0

自己解決

@paramの記述場所にgyomuDateを記述したら消えました。
ありがとうございます。

投稿2018/06/29 02:35

King_of_Flies

総合スコア382

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

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

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

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

ただいまの回答率
85.48%

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

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

質問する

関連した質問