単語が名詞と動詞の両方であるときに変数に名前を付ける方法

以下の一般的なガイダンスで、コーナーケースの問題に遭遇しました。

• 変数の名詞
• 関数の動詞

具体的には、単語があいまいな場合があります-動詞または名詞のいずれかです。また、アプリケーションについて説明している場合には、同じ文で両方の方法で使用されます。

私の意図は、数か月後にコードのセクションに戻ったときに、自分自身だけでなく将来の開発者にもプログラムが読めるようにすることです。

例の1つはbatteryです。Aにbatteryはバッテリーchargeがありcharge()ます。

両方を持つことはBattery.Charge、Battery.Charge(value)将来の開発者にとって混乱を招くと思います。

私の現在の解決策は、これらのケース（変数と関数）のいずれかまたは両方に対して異なる単語を選択することです。そのアプローチに関する私の問題は、Batteryオブジェクトの変数と関数がchargeを含む設計の議論と一致しないことBatteryです。

私の質問は、命名規則のこの競合を処理する別の/より良い方法があるかどうかです。

件名に関するいくつかの追加の読書。私の質問の特定に実際に取り組んだものはありません。

• 意味のある簡潔なメソッド命名ガイドライン
• 変数の命名規則
• https://softwareengineering.stackexchange.com/questions/14169/what-naming-guidelines-do-you-followから選択した回答

同様の状況で、同義語を見つけようとします。この場合、動詞に「リチャージ」を使用します。「再」は少し冗長ですが、意味は明確です。バッテリーの残りの充電に単純な「充電」を使用することは、物理単位を指定しないため、あいまいです。私は「availableAmpHours」、「hoursUntilRecharge」などを好むでしょう。単位は、アプリケーションにとって便利なものに依存します。

私の個人的な好みは、状態を変更する機能にのみ動詞を使用することです。変化しない関数には名詞を使用します。それはあなたの視点に依存すると思います。マシンレベルでは、変化しない関数は何かをしますが、モデルレベルではしません。

これを捨てるだけですが、多分この名前のあいまいさのインスタンスの解決策は、バッテリーからその機能を完全に削除することです。バッテリーを自己充電するのを見たことがないので、BatteryChargerクラスを用意する方が理にかなっています。これにより、懸念をより切り離し、アクションをより明確にすることができます。

battery.Charge(50) 対 batteryCharger.Charge(battery, 50)

私にとって、2番目の形式ははるかに理解しやすく、すべてのバッテリークラスに散らばるのではなく、すべての「充電」コードを1か所に保持します。

二重の意味を避ける

意図的に複数の意味を持つ単語を選択しましたが、その最初の決定が問題です。プログラマーにとって問題のある単語はたくさんあります。別の例は次のようになりますphone。あなたはphone誰か、またはphoneあなたのポケットに入れることができます。

ゲッターとセッターを使用する

ほとんどのオブジェクトの標準の命名は、プロパティのゲッター/設定メソッドです。

Battery.Charge            // would be a property
Battery.setCharge(value)  // would set the property
Battery.getCharge()       // would get the property

プロパティは名詞ではなく状態です

オブジェクトプロパティを名詞として分類するのは間違っていると思います。変数は状態と考えることもできます。それらは、その存在のローカルスコープに関連する状態です。

それらが保持する値を名詞として説明することもできますが、それがすべての場合に当てはまるかどうかはわかりません。

OOPの用語では、オブジェクトプロパティはそのオブジェクトの状態を表します。あなたの場合、BatteryはオブジェクトでありCharge、状態です。したがって、それはオブジェクトのプロパティになりますが、これは使用方法のコンテキストに依存します。

Chargeバッテリーを使用できるようにする必要Chargeがあり、現在のバッテリーが何かを知る必要がある場合は、問題があります。

スコープを使用してコンテキストを強制する

コンテキストとは、メソッドまたはプロパティに伝えることを意図している単語の意味を明確にするものです。スコープは、オブジェクトの外部からプロパティ/メソッドのアクセシビリティを設定しています。

Batter._charge            // a hidden private property
Battery.setCharge(value)  // would set the private property
Battery.getCharge()       // would get the private property
Battery.Charge()          // would perform the Charge action

メソッドは動詞です

オブジェクトのメソッドは動詞として説明できますが、アクションという言葉の方が適しています。OOPの用語では、メソッドを使用してオブジェクトに対してアクションを実行します。オブジェクトの外部からオブジェクトのプロパティを変更するのは悪い方法です。状態を変更するために必要なアクションを実行するメソッドを呼び出すことをお勧めします。

単語Chargeは動詞ですが、名詞でもあります。アクションのメソッドを呼び出すために使用すると、動詞が使用されていることが明らかになりBattery.Charge(....)ます。

しかし、コンテキストは非常に重要です。単語Charge()は動詞ですが、ほど意味がありませんstartCharging()。

以下のための有効な方法はBattery含めることができCharging、Discharging、setCharge、getCharge、hasCharge、DischargeとCharged。

シンプルな1ワード法は、多くの場合、明示的に明確に彼らの行動を述べるませんが、そこにいくつかの例は次のようにしているopenとcloseどこ少し説明が必要です。

そのため、これらのタイプのプロパティ/メソッドに名前を付ける方法に関して、実際には正しい答えはありません。混乱がないように、上記の手法を賢く使用する必要がある場合を除きます。

それらを動詞または名詞にする動詞を追加します。

Battery.doCharge()

Battery.getCharge()

動詞の場合、Charge大丈夫だと思います。名詞の場合、getCurrentChargeLevelあなたのために働くでしょうか？

ほとんどの場合、助動詞、副詞、または形容詞を追加することでそれらを区別するのに十分であり、実際に理解を助けることができます。バッテリーのChargeおよびCharge（）の場合、DeltaCharge（）は、充電または放電のいずれかを処理できる関数であることを示すことができます。

Delta（変化はあるがあいまいな場合）は、状態の変化を処理するために常に使用し、他の人に推奨する修飾子です（動詞が半自明であっても）。

ハンガリー記法による救助。あなたは持つことができますintChargeし、fcnCharge(value)このように混乱を回避し、3つの文字がうまく動作しますとき狂気に長い名前を追加していません、。

または、同じ名前を使用してIDEで処理することもできます。とにかく長い名前を作成することは、長い目で見れば混乱を招くかもしれません。