javadoc

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 Javadocの要約文に、使用を推奨しない語句が含まれていないかチェックする。 {@inheritDoc}タグのみを含む場合、チェックはスキップされ、空でない{@code {@return}}を含む@Summaryは許容される。 最初の文が含まれていないJavadocはチェックNGとなる。 チェック追加バージョン Checkstyle 6.0 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン violateExecution OnNonTightH…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 6.0 Javadocブロックが1行に収まるかどうか、ブロックタグを含まないかどうかをチェックする。 少なくとも1つのブロックタグを含むJavadocコメントは、数行でフォーマットされる必要がある。 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン violateExecution OnNonTightHtml boolean false JavadocがTight-HTMLルールに違反している場合、違…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 8.36 Javadocにブロックタグがある場合、その前に1行の空行があるかどうかをチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン violateExecution OnNonTightHtml boolean false JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか 8.36 設定＋チェック実行結果 プロパティ設定なし 設定…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 6.0 ブロックタグの後に記述があるかどうかをチェックする。 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン violateExecution OnNonTightHtml boolean false JavadocがTight-HTMLルールに違反している場合、違反を表示するタイミングを制御するかどうか 8.3 javadocTokens Javadocトークンの サブセット PARAM_LITER…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 8.22 package-info.javaファイルにJavadocコメントがないかどうかをチェックする。 設定＋チェック実行結果 プロパティ設定なし 設定ファイル記述方法 <module name="Checker"> <module name="TreeWalker"> <module name="MissingJavadocPackage"/> </module> </module> チェック実行例 // OK…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 8.21 メソッドまたはコンストラクタのJavadocコメントが欠落していないかどうかをチェックする。 検証するスコープはScopeクラスを使用して指定し、デフォルトは Scope.PUBLIC。 Overrideアノテーションでタグ付けされたメソッドにはJavadocは必要ないが、Java5以前ではインターフェイスに必要なメソッドをマークすることはできない（これはJava6で修正された）。 Checkstyleでは…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 3.0 変数がJavadocコメントを持つかどうかをチェックする。 serialVersionUIDフィールドは無視される。 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン scope Scope private Javadocコメントをチェックする可視性スコープを指定 3.0 excludeScope Scope null Javadocコメントをチェックしない可視性スコープを指定 3.4 igno…

概要 Hibernate Validatorで複数のconstraint annotationを指定順序で実行し、また、あるannotationが失敗したらそこでvalidationを終了する方法について。 背景 spring-boot-starter-validation というかHibernate Validatorはconstraint annotationにデフォルトでは特定の実行順序は無い。また、すべてのannotationを実行する。なので、たとえば一番最初の@NotEmptyがパスした場合のみ後続の@Sizeに進む、などは追加設定が必要となる。 5.3. Defining gro…

誰が何と言おうと、私はAnt派です。 というわけでIvyIDEAが必要なのですが、とうとう2024.3で動かなくなってしまいました。 java.lang.Throwable: 'module' is requested on EDT by ResolveForActiveModuleAction#presentation@ProjectViewPopup (org.clarent.ivyidea.ResolveForActiveModuleAction). See ActionUpdateThread javadoc. というエラーになります。で、なんとかしてみたらなんとかなりました。 (1)…

きっかけ 前提 環境準備 調査 内容 サンプル実装 感想 関連リンク きっかけ Java23のリリースが近づいてきたので、事前調査。 Javaのリリース時期が、俺の誕生日と近いから、否が応でも思い出すんだよなぁ。。。 前提 環境準備は、sdkman使う。利用方法は明記しない。 2024/09/01時点での内容。 環境準備 sdkmanを使っているので、それで準備 $ sdk install java 23.ea.29-open インストールされているか確認する。 現場猫ばりの確認をしないと、後続の作業がムダになる可能性もあるから、慎重に。 $ javac -version javac 23-e…

ResponseEntityExceptionHandler どの例外が発生したときになにを返すかのハンドリングを行う ResponseEntityExceptionHandlerクラスを継承して例外ごとに定義されているメソッドをオーバーライドすることで、処理カスタマイズできる ResponseEntityExceptionHandler内の定義済みExceptionの実装 @RestControllerAdvice // 割り込み処理設定 class ApiControllerHandler : ResponseEntityExceptionHandler() { // 特定例外をoverr…

概要 Web API: The Good Partsという本を読んで、Web APIの仕様内で統一を図ったほうが良い点があることが分かった。 たとえば、パスで使用する文字列の単語の分かれ目をどのように表現するのか。 この記事では、Spring Web MVCで実装したWebAPIのパスがケバブケースになっているかどうかをJUnitでテストする。 使用する言語やライブラリ Kotlin 1.9.25 Spring Boot Starter Web 3.3.3 JUnit Jupiter 5.10.3 方針 Spring Framework公式リファレンスによると、パスとリクエストハンドラのマッピ…

​​​Javadocのコメントについて ・目次 ​​​Javadocのコメントについて 1.目的 2.コメントの付け方 3.Doxygenでドキュメント作成確認(コメント) 関連記事 1.目的 ・Javadocで使用されるコメントの書き方について記載する。 ・コメントを記載した場合、Doxygenでどのように出力されるのか確認する。 参考：Doxygen(コメント) 2.コメントの付け方 C スタイルのコメント /** * ... コメント ... */ Qt スタイルのコメント /*! * ... コメント ... */ 追加のスラッシュ又は感嘆符で始まるコメント /// /// ... コ…

​​​ ・目次 ​​​ 1.目的 2.Doxygenのダウンロード 3.Doxygenでドキュメント作成 4.Doxygenの書き方 5.Doxygenでドキュメント作成ファイル確認 関連記事 1.目的 ・DoxygenはソースファイルからJavadocに則ったコメントを使用することにより、ドキュメントの作成が出来る。 ・Doxygenのインストールとドキュメント作成プロセスについて説明する。 マニュアル：Doxygen 2.Doxygenのダウンロード ・Doxygenのダウンロード →Doxygen 上記公式ホームページのダウンロードから、Doxygenのダウンロードが出来る。 (Doxy…

Doxygenとは ・目次 1.目的 2.Doxygenとは（Doxygenの特徴) 3.Doxygenのメリット 4.まとめ 関連記事 1.目的 ・Doxygenについて知り、主に何が出来るのかを把握する。 ・DoxygenはJavadocスタイルのコメントを使用してソースファイルからドキュメントを生成できるツール。 ・Doxygenの特徴や出来ること、メリットについて記載する。 マニュアル：Doxygen 2.Doxygenとは（Doxygenの特徴) (1) ソースコードやコメントからドキュメントを自動生成するツール (2) 様々なドキュメントの作成が可能 ・ クラス図や関連図などの図表…

※本記事は、ChatGPTによる意訳+翻訳を活用し、レイアウト調整したものです。 ※元記事を見て、内容がズレていないか査読するようにしています。 ※感想は、オリジナルです。 原文 意訳+要約 APIドキュメントの目的と開発における重要性 APIドキュメントの目的 APIドキュメントのベストプラクティス ChatGPTへのQA Ｑ：APIドキュメントに含めるべき情報は何ですか？ Ｑ：APIドキュメントでサポートコストが減ったとしても、ドキュメント作成の工数がかかるのではないでしょうか？ Ｑ：APIドキュメントを効率的に作る方法は、何かありますか？ 感想＋雑記 原文 意訳+要約 APIドキュメント…

これは、なにをしたくて書いたもの？ JavaのRecordsを使っているとビルダーが欲しいなと思うのですが、自動生成してくれるライブラリーがあるようなので試してみました。 Recordsのビルダーを生成するライブラリー 今回見つけたのはこちらです。 Jilt。Recordsでなくてもビルダーを生成することができます。 GitHub - skinny85/jilt: Java annotation processor library for auto-generating Builder (including Staged Builder) pattern classes RecordBuild…

昨日の発表資料です（資料？https://t.co/GKPhtBKprx #kanjava — Toy (@mdstoy) 2024年7月31日 関ジャバ'24 7月度 - connpass のショートセッションで出てきたネタ、「条件演算子の二項目と三項目が違う型でも動くことがあるやつ」の言語仕様解説。 // これはいける System.out.println(i % 3 == 0 ? "Fizz" : i); // これは無理 String str = (i % 3 == 0 ? "Fizz" : i); この挙動はなぜなのか？ §15.25. Conditional Operator ? …