Java コーディング規約。どれに従うべきか、そしてその理由

業界標準とベストプラクティスを知り、それに従うことは、どの分野でも非常に重要ですが、特にコーディング言語、ツール、アプローチ、テクノロジーが複雑で、場合によっては混沌と混在するプログラミングでは非常に重要です。そのため、プロの Java プログラマーは、今日説明する Java コーディング規約に精通している必要があります。 Java コーディング規約。どれに従うべきか、そしてその理由 - 1

コーディング規約とは何ですか?

コーディング規約は、コーディングスタイル、ベストプラクティス、手法など、この言語でのソフトウェア開発のさまざまな側面に関する推奨事項を記載した、特定のプログラミング言語ごとの一連のガイドラインです。コーディング規約は、この言語でコーディングしているソフトウェアプログラマーが、自分のコードが読みやすく、他の人によるソフトウェアの適切なメンテナンスが可能であることを保証するための品質ガイドとして従うことを目的としています。通常、コーディング規約は、ファイル構成、インデント、コメント、宣言、ステートメント、空白、命名規則、プログラミングの実践、プログラミングの原則、プログラミングの経験則、アーキテクチャのベストプラクティスなどを含む、このプログラミング言語でソフトウェアを作成するためのすべての重要なコンポーネントをカバーしています。。

コーディング規約の目的は何ですか?

ソフトウェア開発においてコーディング規約が重要な役割を果たす理由は数多くあります。

統一されたコードスタイルの維持

コーディング規約に従うことで、ソフトウェアプロジェクトを単一の統一されたスタイルで記述することができ、これは次のようなさまざまな点で有益です。

ソフトウェアのメンテナンスコストを最小限に抑える

最も重要なことの 1 つは、プログラムのオリジナルの作成者がソフトウェア製品をサポートしていないことが非常に多いため、ソフトウェア製品の保守とサポートを容易にすることです。ソフトウェアの生涯コストの 80% がメンテナンスにかかるため、これは重要です。

ソフトウェアの可読性の向上

ソフトウェアの可読性の向上も大きな利点であり、プロジェクトへの新しい開発者の導入の簡素化や開発チームメンバーのコラボレーションの効率の向上など、複数の意味もあります。

作業のスピードアップ

最後に、ソフトウェア開発プロセスを可能な限り迅速に進めるためには、コードを適切に記述して構造化することが必要です。

Java コーディング規約

Java に関しては、最も一般的でよく知られているコーディング規約が 2 つあります。Oracleの Java コード規約とGoogle の Java スタイルガイドコーディング規約です。

Oracle の Java コード規則

Oracle のコード規則は、多くの明白な理由から最も重要なものとして認識されています。Oracle のコード規則は、Oracle が Java の所有者であるため公式のものであり、最も古いものでもあります (このドキュメントの最終改訂は 4 月 20 日に行われました)。 1999年）。Oracle の Java コード規約の重要な部分のいくつかは、クラス、メソッド、または変数を定義するときにキャメルケースを使用すること、クラスを大文字で開始し名詞を名前に使用すること、動詞を命令形で使用して開始することを推奨することです。メソッドの小文字からなど。

Google の Java スタイルガイド

Google の Java コーディング規約は、あらゆる種類の Java アプリケーションの開発において豊富な経験を持つ学習型インターネットおよびテクノロジー企業としての Google の地位により重要であると考えられています。もう 1 つの重要な理由は、Google の Java コード規則が 2018 年 5 月 22 日に更新されたという事実です。これにより、特に Java 8 の一部としてのみリリースされた Java の比較的新しい機能を記述する場合には、Oracle のコード規則よりも関連性が高くなります。 2014 年にはラムダやストリームなど。Google の Java スタイルガイドの著者は、このコーディング規約の内容を次のように説明しています。「この文書は、Java のソースコードに対する Google のコーディング標準の完全な定義として機能します。他のプログラミングスタイルガイドと同様に、取り上げられている問題は、書式設定の美的問題だけでなく、ただし、他の種類の規約やコーディング標準も同様です。ただし、この文書は主に私たちが普遍的に従う厳格なルールに焦点を当てており、（人間によるものであろうとツールによるものであろうと）明確に強制力のないアドバイスの提供は避けています。」「Google Java Style Guide は、ほとんどの部分で優れた参考資料ですが、一部のトピックについては少し寛容です。一方、Java プログラマーとしては、特にコードのインデントに 4 つのスペースを使用することに慣れている必要があります」と、ソフトウェアアーキテクトで経験豊富な Java プログラマーである David Rios 氏は LinkedIn で述べています。ただし、いくつかのトピックについては少し寛容です。一方、Java プログラマーとしては、特にコードのインデントに 4 つのスペースを使用することに慣れている必要があります」と、ソフトウェアアーキテクトで経験豊富な Java プログラマーである David Rios 氏は LinkedIn で述べています。ただし、いくつかのトピックについては少し寛容です。一方、Java プログラマーとしては、特にコードのインデントに 4 つのスペースを使用することに慣れている必要があります」と、ソフトウェアアーキテクトで経験豊富な Java プログラマーである David Rios 氏は LinkedIn で述べています。彼自身の Google Java Style Guide への適応案をいくつか載せて投稿しました。