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…

今回はリーダブルコード6章より「良いコメント」を書くための方法を解説します。 www.oreilly.co.jp 本シリーズ：リーダブルコードの解説 各記事のリンクはこちらをクリック リーダブルコード 未来の自分を助ける 01 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 02 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 03 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 04 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 05 - こだわりデベロッパーズノート リーダブルコード 未来の自…

今回はリーダブルコードの5章より「読みやすいコード」とするために記載する「コメント」の重要な考え方について触れていきます。 www.oreilly.co.jp 本シリーズ：リーダブルコードの解説 各記事のリンクはこちらをクリック リーダブルコード 未来の自分を助ける 01 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 02 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 03 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 04 - こだわりデベロッパーズノート リーダブルコード 未来の自分を助ける 05 - こだわりデ…

これは、なにをしたくて書いたもの？ Java 11からHTTPクライアントが導入されましたが、そういえば触ったことがありませんでした。 自分でも1度試してみようかなということで。 JEP 321: HTTP Client HTTPクライアントは、「JEP 321: HTTP Client」で導入されました。 JEP 321: HTTP Client Java 9でincubating APIとして導入され、その後Java 11で正式版になったわけです。 Java 9時点でのJEPは、こちらの「JEP 110: HTTP/2 Client (Incubator)」でした。 JEP 110: HT…

未経験でweb系自社開発企業の面接を突破したり、するため 「未経験 web系 ポートフォリオ」等のキーワードで検索して、 ポートフォリオの、クオリティのラインや法則を調査してみた。 勝俣健太さんの見解を要約 Web系自社開発企業さんへの転職に必要なポートフォリオのレベルとは https://www.youtube.com/watch?v=N0yetny4Zco スクールで作ったポートフォリオが役に立たない理由： ①「初学者のポートフォリオレベルが高くなってるので、授業で作ったアプリでは見劣りしてしまう」 ②スクールの作品しか成果物がないなら、プライベートの学習をしない人と思われてしまう。 We…

2023年08月22日(Tue)の呟きは 58

これは、なにをしたくて書いたもの？ JavaでUUIDを使おうと思ったら、java.util.UUID#randomUUID#toStringでバージョン4のUUIDを使っていると思います。 UUID (Java SE 17 & JDK 17) でも、UUIDってバージョン4以外にも種類がありましたよね、ということで、Javaでバージョン4以外のUUIDを扱えるライブラリーを 調べてみました。 UUIDのバージョン そもそも、UUIDについて少し見ておきましょう。UUIDのRFCはこちらです。 RFC 4122: A UUID URN Namespace UUIDは128ビットの数字で、一意の…

この記事では、Javaプログラミングを始める入門者向けに、ベストプラクティスとコーディング規約を紹介します。 目次 コーディング規約とは 命名規則 コードフォーマット コメントの記述 エラー処理 パフォーマンスと最適化 まとめ 1. コーディング規約とは コーディング規約は、ソースコードの可読性や保守性を向上させるための一連のルールやガイドラインです。これを遵守することで、チームでの開発効率が向上します。 2. 命名規則 クラス名: アッパーキャメルケース（UpperCamelCase） java public class MyClass { } メソッド名と変数名: ロウワーキャメルケース（…

本記事では名著Effective Java(第3版)で言及されているtipsをより深掘りするために、さまざまなコード例を交えて考えるというものになります。 今回は第2章 オブジェクトの生成と消滅の中の項目1「コンストラクタの代わりにstaticファクトリメソッドを検討する」について深掘りします。 目次 Staticファクトリメソッドとは？ Staticファクトリメソッドのメリット Staticファクトリメソッドのデメリット おわりに 1. Staticファクトリメソッドとは Staticファクトリメソッドとは、「クラスのインスタンスを返す単なるstaticのメソッド」であり、クラスのコンストラ…

軽く流し読み。

フィードバック 古い習慣では生き残れない窮地になってはじめて、より優れた新製品開発手法が必然的に生まれてきた。 そのような、堅牢な開発プロセスにはかならず２つの共通点がある。 １．秀逸ですばやいフィードバック ２．優れた詳しい規律 リリース計画 計画は、市場ニーズ（あるいはビジネスニーズ）、製品コンセプト、目標コスト、稼働タイミングを見極めるところからはじまる。 １．初期投資期間中には、詳細な長期計画を作らず、短期間でインクリメンタルなリリース計画を作成する。 ２．直近の開発についての計画を立て、最も重要な機能を見つけ出し、その土台となるアーキテクチャを確立させる。 ３．収益獲得（や投資の回収…

JUnit 5のassertions 毎回分からなくなるので、おさらい。ドキュメントはここ。 junit.org これだと一覧性はないので、以下のJavaDocを見ると良いかも。 junit.org ただ、これだけだと厳しいものもあるのでサードライブラリがある。 junit.org なんとなくHamcrestを選択。 hamcrest.org これだと分かりにくかったので以下の記事を読んでおく。 www.baeldung.com

読もうと思った経緯 GitHubの開発プロセスを最適化し、効率的なコラボレーションを実現するために、ベストプラクティスを紹介してある。 プロの目線からアイデアをまとめ、リポジトリの構成方法、コラボレーションのワークフロー、コードレビュー、自動テスト、ドキュメンテーション、セキュリティのベストプラクティスなどについて詳しく解説している。 この記事を読めば、開発者やチームはGitHubを最大限に活用し、生産性を向上させる方法を理解できるのではないかと思い、要約してみた。 原文 GitHub’s Best Practices(Streamlining Collaboration and Maximi…