javadoc

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.20 クラス、enum、インターフェース、およびアノテーション・インターフェース定義の Javadocコメントが欠落していないかどうかをチェックする。 検証するスコープはScopeクラスを使用して指定し、デフォルトは Scope.PUBLIC。 プロパティ プロパティ 型 デフォルト値 説明 追加バージョン scope Scope public Javadocコメントをチェックする可視性スコープを指定 8.20 …

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…

CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン：10.3.3 Javaバージョン：17 チェック概要 チェック追加バージョン Checkstyle 3.0 型定義のJavadocコメントをチェックする。 デフォルトでは、authorやversionのタグはチェックしない。 検証するスコープはScopeクラスを使用して指定し、デフォルトはScope.PRIVATE。 他のスコープを確認するには、プロパティscopeにScope定数のいずれかを設定する。 authorタグやversionタグのフォーマットを定義するには、authorFormatプロパティとversi…

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

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公式リファレンスによると、パスとリクエストハンドラのマッピ…

はじめに 毎回どれがどれだっけとなるので備忘録としてメモしておきます。 シリアライズとデシリアライズ JSONの処理において、オブジェクトをJSON文字列に変換する処理の方が「シリアライズ(Serialize)」です。 オブジェクトは一般的にはkeyとvalueのペアが含まれており、構造化・階層化がなされています。 これを文字列という、メモリ上で直列に保持される単一の値に変換するため、直列化(シリアライズ)という単語によって表現されているようです。一方のJSONの文字列をオブジェクトに変換する方は「デシリアライズ(Deserialize)」です。 これはシリアライズの逆で、JSON文字列をオブ…

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

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ドキュメント…

はじめに こんにちは。技術本部ECプラットフォーム部マイグレーションブロックの小原です。 本記事では、Spring BootのApplicationRunnerインタフェースを活用したバッチアプリケーション（CLIアプリケーション）の構築方法について解説します。 バッチ処理の実装において、SpringフレームワークはSpring Batchという強力なツールを提供しています。しかし、比較的単純なバッチ処理の場合、Spring Batchの使用はオーバーエンジニアリングとなる可能性があります。 そこで、軽量なアプローチとしてApplicationRunnerを利用した実装方法を説明します。この方…

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

※本記事は、ChatGPTによる意訳+翻訳を活用し、レイアウト調整したものです。 ※感想は、オリジナルです。 原文 意訳+要約 Docs as Code: テクニカルライターのためのベストガイド Docs as Codeとは？ 主な利点 実践のステップ 成功への鍵 ChatGPTへのQA Ｑ：MarkdownとreStructuredText、それぞれの利点は何ですか？ Markdownの利点 reStructuredTextの利点 まとめ Ｑ：「Docs as Code」を既存のプロジェクトに適用するには、どのようにすればいいでしょうか？ 1. 現状の把握と計画の立案 2. ツールと技術の選…

これは、なにをしたくて書いたもの？ JUnitテスト実行時に、Flywayを組み合わせて使いたいなと思いまして。 よくDatabase Riderを使うので、今回はJUnit 5 ExtensionとしてDatabase Riderの実行前にFlywayマイグレーションを動かすように組み込んで みたいと思います。 FlywayとJUnitテスト Spring BootのようにFlywayをサポートしていて、コンテナの起動時に実行してしまうようなものを使ったらいい、では話が終わってしまうので 今回はそのような構成は対象外にします。 Flywayサポートがない状態でもテスト時に実行したい場合は？と…

少し古い話題ですが、最近コンパクトプロファイル（Compact Profile）と呼ばれる仕組みがJava SE 8で導入されていたことを知りました。今後新規案件でJava SE 8を使うことはないかもしれませんが、どのような機能か気になったので簡単に調べたことをメモします。 コンパクトプロファイル（Compact Profile）とは？ Java SE 8でコンパクトプロファイル（Compact Profile）と呼ばれる機能が導入されました。これは、Javaを動かす環境ごとに必要なAPIのみを選択することができる仕組みのようです。たとえば、モバイルデバイスなどではリソースが限られるため、実…