以下メッセージを確認しました。
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も作成されています。
回答1件
あなたの回答
tips
プレビュー
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。