不変を暗示するために過去形(受動音声)を使用しますか?(例:Array.TransposedとArray.Transpose)
[注:以下は、FxCopルールの引用など、構文と規則が少しC#で重いです。これは私の背景ですが、この説明の意図は言語に依存せず、使用されるコード例は一般に疑似コード。—マイク] クラスは一般に、オブジェクトインスタンスが実際的な場所では不変であり、クラスメンバーの呼び出し結果にはできる限り副作用がないように設計する必要があることに、私たちは全員同意するでしょう。 ただし、歴史的な命名規則では、「GetSomething」、「DoSomehing」などのアクティブな音声を使用する傾向があり、クラスメンバーが実行するアクションが明確に示されているため、これは適切です。 ただし、メンバーが過去形で名前が付けられると、参照されるオブジェクトに影響を与えることなく値が返されることを暗示することで、時々(または場合によっては)メリットが得られると考え始めています。 たとえば、配列を転置するメソッドの場合、現在の命名スタイルではおそらく 'Array.Transpose'と呼ばれますが、このメンバーが参照されたオブジェクトを転置せずに新しい配列を返す場合、それを 'Array.Transposed'と呼ぶと思います'はより正確になり、プログラマにわかりやすくなります。 'Array.Transpose()'メソッドを使用する場合、誤って次のようなコードを使用しようとする可能性があります。 Array myArray = new Array(); myArray.Transpose(); ただし、「Transpose」メソッドが参照オブジェクトに影響を与えずに新しい配列を返す場合、このコードは何もしません。つまり、「myArray」は静かに転置されません。(「転置」がプロパティである場合、コンパイラは上記が正当ではないことをキャッチするでしょうが、FxCopガイドラインでは、変換を実行するメンバーはメソッドである必要があると述べています。) しかし、メソッドが過去形で 'Array.Transposed'と名付けられている場合、次の構文が必要であることはユーザーには明らかでしょう。 Array myArray = new Array(); Array transposedArray = myArray.Transposed(); このカテゴリに当てはまると思う他の名前は、「サイズ変更」対「サイズ変更」、「シフト」対「シフト」などの名前のメンバーです。現在の時制は、参照オブジェクトに影響を与えるメンバーに使用されますが、過去形は、参照されるオブジェクトに影響を与えずに新しい値を返すメンバーに使用されます。 現在より一般的な別のアプローチは、各名前の前に「Get」または「To」を付けることですが、過去形に変更すると意味が効果的に伝わり、不要な重みが追加されると思います。 これはここの他のプログラマにとって意味がありますか、それともこの過去形のアイデアは、それを読むときにあまりにぎこちないように聞こえますか? 編集: 以下の素晴らしい議論、私は皆に感謝します。以下に、あなたのコメントとこれに対する私自身の修正された考え方に基づいて要約したいいくつかのポイントを以下に示します。 「流暢な」構文を連鎖させるメソッド 以下の説明に基づいて、参照されるオブジェクトの内部状態に影響を与えるメンバーまたは影響を与えないメンバーを明確にするために、可変クラスで使用する場合、過去形の使用はおそらく価値があります。 ただし、不変クラスの場合、これはケースの大部分になるはずです(希望するでしょう)、過去形を使用すると、構文が不必要に扱いにくくなる可能性があると思います。 たとえば、メソッドチェーンによって作成されるような「流暢な構文」では、過去形を使用するとコードが読みにくくなります。たとえば、C#を介してLINQを使用する場合、一般的なメソッドチェーンは次のようになります。 dataSource.Sort().Take(10).Select(x => x.ToString); 過去形に変更すると、これは扱いにくくなります。 dataSource.Sorted().Taken(10).Selected(x => x.ToString); ちなみに、LINQ式は常にソースに影響を与えずに新しい列挙を作成するため、dataSource.Sorted()は実際にはdataSource.Sort()よりも意味が明確です。ただし、このパラダイムを使用するときはこれを十分に認識しているため、過去形の使用は冗長であり、それを読み取る「流暢さ」が本当の意味で不便になります。 プロパティとメソッドの使用 以下で取り上げられた重要な問題は、「取得」メソッドと読み取り専用プロパティの使用に関するFxCopガイドラインに関係しています。例:FxCopルールCA1024。 そのFxCopルールでは明示的に言及されていませんが、ToXXXXXX()メソッドは変換メソッドであるため、「To」メソッドの使用はこの根拠にも適用されるようです。また、ToArray()の場合、メソッドは変換メソッドであり、配列を返すメソッドでもあります。 ブールプロパティの過去形の使用 一部の人は、過去形がブール値を暗示する可能性があることを示唆しました。たとえば、「成功」または「接続」プロパティ。ブールのプロパティとフィールドに「Is」、「Has」、または「Are」の使用を強調する以下のレトルトは正しいと思います。過去形もこの点で役立ちますが、「Is」接頭辞を使用する場合ほどではありません。ブール値のプロパティとフィールドに過去形を使用してもかまいませんが、役立ちますが、名前の前に「Is」、「Has」、または「Are」を付けることがさらに重要だと思います。 全体的な結論は? Tranpose()とTransposed()の問題については、 …