C#のプライベートメソッド命名規則について

Question

今まで業務で使用してきた言語がC言語の者です。
このたびC#をかじってみようと、C#の命名規則を調べています。

そこで、主題の件ですが、
C#は基本的にはSnake形式は使用せず、Pascal形式とCamel形式を使用するというのはわかりました。

ググってみたところ、MS公式としては、メソッドはPascal形式ということなのですが、プライベートメソッドも同様なのでしょうか。
参考元：メソッドの名前付けのガイドライン

もしそうなら、いささか抵抗を感じます。
また、公開と非公開を同じPascal形式にすることにメリットを感じません。（メンバ変数は非公開をCamel形式にするのに）
というか、そもそもプライベートメソッドに関しては言及していないようなニュアンスを感じるのは気のせいでしょうか・・・

さらに、MS公式以外では、「私はプライベートメソッドはCamel形式を使っています」というサイトも多く見受けられました。

質問点としては以下の通りです。

• C#のプライベートメソッドに関する命名規則について、MS公式等で公表されているものはあるのか。
• プライベートメソッドがPascal形式だとして、それによるメリットは何か。また、皆さんはそれに準拠されているのか。

以上、よろしくお願い致します。

Answer 1

こんにちは。

C#のプライベートメソッドに関する命名規則について、MS公式等で公表されているものはあるのか。

最新版がここにありました。
特にpublic/privateの区別なくメソッドはPascal形式と書かれてますね。
privateもPascal形式と解釈するのが妥当と感じます。

プライベートメソッドがPascal形式だとして、それによるメリットは何か。また、皆さんはそれに準拠されているのか。

メソッドもなるべくprivateに入れますが後でpublicの方が良いとか、基底クラス側はprotectedが良くて派生クラスはpublicが良いようなケースもあります。
そのような時、命名規則を一々変えていると無駄な手間が掛かるので、私はメソッドの命名規則は一律としています。

私が決めることができる場合にメソッドに割り当てているのは動詞で始めるキャメルです。
ただ、どう頑張っても、キャメル、パスカル、スネークだけでは必要な命名規則が不足しますので、この３つに拘ってはいません。メンバ変数（プロパティ、フィールド）、引数（in, out, in/out）、ローカル変数、グローバル変数（static変数）、TLS変数、クラス名、enum名、enumシンボル名等、名前を見ただけで判別したいものが盛り沢山です。

Comments

[Y.H.]

名前付けのガイドラインの最新版探してました。リンクありがとうございました。

[退会済みユーザー]

ありがとうございます。

リンク先を拝見いたしましたが、プライベートメソッドでPascal形式を使った例は見つかりませんでした。
しかし、
>そのような時、命名規則を一々変えていると無駄な手間が掛かるので、私はメソッドの命名規則は一律としています。
には、はっとするものがありました。
ハンガリアン記法の問題と似たものがありますね。

[Chironian]

> リンク先を拝見いたしましたが、プライベートメソッドでPascal形式を使った例は見つかりませんでした。

よく見ると、最初のページにpublicとprotectedのみ必須(required)と明記されてます。
privateメンバへの要求事項ではないということですね。
ですので、privateメンバへは異なる命名規則を割り当てても、このガイドラインに則っているとは言えそうです。

ところで、ふと気になったのですが、Javaはpublic, privateで異なる命名規則をメソッド名に採用する習慣があるのでしょうか？　ちょっとびっくりしてます。

[退会済みユーザー]

すみません、私自身も勘違いしていましたが、javaではpublic, privateでも関係なくメソッドはCamel形式です。（もしかしたら私の環境だけかもしれませんが、ググってみたら一般的ではあるようです）
普段はC言語の業務が主なので（そしてその場合はグローバル関数はPascal形式、ローカル関数はCamel形式です）、こんがらがっていました。

Answer 2

こんにちは。
自分の場合は「メソッド/プロパティはaccesibilityに関係なく全てPascal形式」に統一しています。
自分もC#を始めた頃同じように悩んだことを覚えています。確かにガイドライン上ではprivateなものについては言及されていなかったように思います。ガイドラインはあくまで「ライブラリとして公開する場合のマナー」のようなものであり、内部に言及するものではなかったみたいですね。
と、Pascal形式を選択した理由についてですが。

• MSのライブラリや、有名な各種.NETライブラリの中身をDisassembleするとまずPascalで書かれている
• privateメソッドをCamelにしたとしても書き心地に影響しそうになかった（IntelliSenseが優秀なのもあって）
• むしろメソッドがCamelだとdelegeteを使ってるように見えてなんだかムズムズする

みたいな、ゆるゆるな理由によるものです。
結局のところ好みで選んでも良いと思いますが、殆どのライブラリがPascalで書かれている以上、それに流されちゃった感じですね。

Comments

[退会済みユーザー]

ありがとうございます。

なるほど、理由に関してかなり説得力があります。
参考にさせていただきます。

Answer 3

私の場合はコーディング規約(命名規約 etc...)を考えるのが邪魔くさいので、コード分析機能をbuildタスクに組み込んでいます。命名規約などはもうMSが提供しているルールセットにお任せです。
（なかには？？？なものや無理ゲーなものがありますがそういうのは適時除外設定してます）

参考
(MSDN)コード分析を使用したマネージ コードの品質の分析
(CodeZine)Visual Studioのコード分析機能を利用してコードの品質を上げよう

Comments

[退会済みユーザー]

ありがとうございます。

VSにはこういう機能もあるんですね。
参考サイト読ませていただきます。

Answer 4

・C#のプライベートメソッドに関する命名規則について、MS公式等で公表されているものはあるのか。
あるのかも知れませんが、公式のは見たことありませんね。。

プライベートメソッドがPascal形式だとして、それによるメリットは何か。また、皆さんはそれに準拠されているのか。

業務でJava、C#両方とも５年ほどやっていますが、
プロジェクトごとにどれかを選択して、
Snake形式、Pascal形式、Camel形式どれも使用しています。
※C#は基本的にメソッド、クラス変数はPascal形式ですが。。
（C#でCamel 形式のメソッドを定義したりするとJavaからC#に来たんだな的な感じに思われることが多いです。）

個人的にはメソッドの命名にメリットもデメリットもない気がします。
あくまでルール決めして、ぱっと見て分かるようにする程度なので、
どれを選択しても差はないように思います。

Comments

[退会済みユーザー]

ありがとうございます。

確かに、プロジェクトごとに従うべきですね。
ただ、やはり基本的にはPascal形式なんですね。