頭字語を使用した Java 命名規則 [closed] 質問する

頭字語を使用した Java 命名規則 [closed] 質問する

DVDPlayer次の Java クラスまたはの正しい名前は何ですかDvdPlayer?

ベストアンサー1

答えとしては、Java にはこれに関する単一の標準が存在しないということのようですが、.NET Framework 設計ガイドラインではこれが規定されていることを指摘しておきます。

さて、話題から外れていると私を非難する前に、Java と .NET Framework のクラス命名ガイドラインは非常に似ているため、.NET ガイドラインは説得力のあるリファレンスとして役立つことを思い出してください。

一般的なルール

どちらのガイドラインも、頭字語が広く知られ、よく理解されている場合にのみ頭字語を使用することを推奨しています。DVD や XML は、この好例です。これらはすぐに認識できますが、拡張バージョンを認識するには少し時間がかかります。

略語

.NET Framework ガイドラインでは、略語 (頭字語ではなく) を使用しないことを推奨しています。ただし、識別子では とIDという2 つの一般的な略語OKを使用できます。略語を使用する場合は、CamelCase 識別子 (PascalCase 識別子ではなく) の最初の単語を除き、常に大文字と小文字が混在しIdて使用されます。

Java では、この規則が守られるのはごくまれです。JCLでとのスペルが混在している様子を見てください。(そのページを途中までスクロールしてください)。ただし、Java 8 バージョンではがますます多く使用されるようになり、これは PascalCase 規則が現在好まれていることを示唆しています。可能な限り、省略形を完全に避けるのが最善です。getIDgetIdgetId

短縮頭字語

.NET Framework ガイドラインでは、 のような 2 文字の頭字語はIO、両方の文字の大文字と小文字が同じである必要があります。したがって、PascalCase の識別子 (クラス名など) の場合は になりDBRate、camelCase の識別子 (ローカル変数など) の場合は になりますioChannel

これは間違いなく Java でも一般的な慣例であるようです。

長い頭字語

.NET Framework ガイドラインでは、3 文字以上の頭字語では、CamelCase 識別子の最初の単語を除き、PascalCase と CamelCase の識別子に大文字と小文字を混在させることが推奨されています。したがって、クラス名の場合はXmlDocument、ローカル変数の名前は になる可能性がありますhttpRequest

This convention is not always followed in Java. Four character acronyms do seem to usually use mixed case, but even the JCL is not consistent about three letter acronyms. Most of them seem to be all uppercase, like URL, XML, SQL, and DOM, but there are some exceptions like Jar.

Conclusion

For Java:

For 4+ letter acronyms, use mixed case. The standard library does this, and it just makes good sense.

For 3 letter acronyms, you can use all uppercase like the JCL, or you can use mixed case like the .NET Framework does. Either way, be consistent.

For 2 letter acronyms, use all uppercase.

For 2 letter abbreviations, Java does not really have a standard, but I suggest using mixed case, unless consistency with other names would make all uppercase look better.

おすすめ記事