web-dev-qa-db-ja.com

頭字語のC#命名規則

頭字語のC#の命名に関して、Windows APIに関連するライブラリを作成していた場合、WindowsApiまたはWindowsAPIのいずれかに強い規則がありますか、それとも個人的な好みですか?

68
deltanovember

規則があり、2文字を超えるすべての頭字語に対して、最初は大文字、残りは小文字を指定します。したがって、HttpContextおよびClientIDです。

58
David Hedlund

" Framework Design Guidelines " Krzysztof Cwalina and Brad Abramsによる第2版pp.40-42

3.1.2頭字語の大文字化

[〜#〜] do [〜#〜]キャメルケースの識別子の最初の単語を除き、2文字の頭字語で両方の文字を大文字にします。

System.IO
public void StartIO(Stream ioStream)

[〜#〜] do [〜#〜]キャメルの最初の単語を除いて、3文字以上の頭字語の最初の文字のみを大文字にします大文字の識別子。

System.Xml
public void ProcessHtmlTag(string htmlTag)

しないでくださいキャメルケースの識別子の先頭で、頭字語の文字を長さに関係なく大文字にします。

33

ここでマイクロソフトの公式の命名ガイドラインを確認してください 命名ガイドライン

9
Feryt

略語は避けるべきだと聞いたので、その場合はWindowsApplicationProgrammingInterfaceになります。

もっと真剣に(人々は、下の引用にもかかわらず、人々は上記を誤って読んでいるようです)、 このページ は言います:

3文字以上の頭字語はすべて大文字ではなくPascalの大文字にする必要があります。

APIはよく知られている頭字語と見なされているため、ガイドラインに従う場合は、WindowsApiという名前を選択します。

8
unwind

古い質問、新しい答え。

頭字語の.NET 4大文字化ルール によると:

キャメルケースの識別子の最初の単語を除いて、2文字の頭字語の両方の文字を大文字にします。

DBRateという名前のプロパティは、Pascalの大文字の識別子の最初の単語として使用される短い頭字語(DB)の例です。 ioChannelという名前のパラメーターは、キャメルケースの識別子の最初の単語として使用される短い頭字語(IO)の例です。

キャメルケースの識別子の最初の単語を除いて、3文字以上の頭字語の最初の文字のみを大文字にします。

XmlWriterという名前のクラスは、Pascalの大文字の識別子の最初の単語として使用される長い頭字語の例です。 htmlReaderという名前のパラメータは、キャメルケースの識別子の最初の単語として使用される長い頭字語の例です。

キャメルケースの識別子の先頭では、頭字語の文字を長さに関係なく大文字にしないでください。

xmlStreamという名前のパラメーターは、キャメルケースの識別子の最初の単語として使用される長い頭字語(xml)の例です。 dbServerNameという名前のパラメーターは、キャメルケースの識別子の最初の単語として使用される短い頭字語(db)の例です。

7

これはすべて、個人的な(または組織的な)好みです。首尾一貫している限り、大丈夫です。

.NET Framework自体はWindowsApiを使用します。

3
John Saunders

その個人的な好み。しかし、.NETはWindowsApiを使用します。 TcpClientの命名に似ています。

3
Daniel A. White

FxCopも見てください。これは、このような問題に役立つ素敵なユーティリティです。

1
Tim Scarborough