c#プロジェクトの命名について

Question

知りたいこと

Visual Studio 2019、C#で開発を行っています。（とはいえ、今回の質問に言語はあまり関係ないと思います。）
知りたいことはプロジェクトの命名規則です。

前提として、以下のようなプロジェクトがあると思ってください。

• AAA (exeを作成するプロジェクト。製品固有)
• BBB (exeを作成するプロジェクト。製品固有)
• CCC (exeを作成するプロジェクト。製品固有)
• DDD (exeを作成するプロジェクト。製品固有)

AAA～DDDは、同じ製品で使うexeなのでデザインや処理などを共通化したいと思っています。
共通かする場合、以下の２種類の共通化が考えられると思います。

1. この製品でしか使用しない共通ロジック（orデザイン）　⇒共通X
2. この製品に依存しない共通ロジック（orデザイン）　⇒共通Y

例えば、AAA～DDDで共通のアイコンを使いたいと思えば、それは共通Xに入れると思います。
しかし、数値計算アルゴリズムなど、製品には依存しないロジックは、共通Yに入れると思います。

そこで、共通Xと共通Yの名前として、どのような名前が適切かをお伺いしたいと思いました。

また、共通Yに関しては、行う処理の種類によってY1、Y2、Y3…と複数に分かれることも想定できると思いますし、
大規模な開発であれば、当然そうすべきなのでしょうが、今回は小規模なので、出来れば共通Yを1つのライブラリにしたいと思っています。
共通Xも1つが良いです。

そういった場合に、適切な名前は何が良いでしょうか？

Comments

[BeatStar]

そもそも、このAAAAとかBBBBとかなんでしょうか?
単にGUIでメインウィンドウとサブウィンドウ、設定画面...とやるような場合は
単に新しくフォームを一つの実行ファイル内で生成してやればいいです。
それのことを書いていらっしゃるのでしょうか?
それともexeじゃなくてDLLとか?
またはバンドルして使う...なのか...
用途が不明すぎて、イメージができません。

[退会済みユーザー]

質問者さんが組織の一員として開発を行っているので貼れば、組織で命名規則を決めて、質問者さんはそれに従うという話になると思うのですが？　組織内で相談してみてはいかがですか？

Answer 1

そもそも**良い命名方法が何か？**ということから考えるべきです。
私は中身のコンテンツが想像できるような名前の付け方が良いと考えています。

共通Xの場合は**「その製品でしか使用しないこと」「用途がXXXなこと」**が一目見てイメージしやすい名前を付けます。

共通Yの場合は特定の製品に依存しないとのことなので、特定の製品名などの具体的な名前は含めないようにします。
そして、**「用途がYYYなこと」**が一目見てイメージしやすい名前を付けます。

他にも、共通Yが社内でしか公開しない想定であれば社名を含めるなどが考えられます。

ポイントは具体性を適度に持つような命名をすることです。
具体的すぎる名前だと後々替えが効かなくなりますし、抽象的すぎる名前だと何を表しているプロジェクトかが分からなくなりますから。

Comments

[LaLaLand]

ありがとうございます。その通りですね。

Answer 2

命名は設計と切っても切れない関係なので、どのような設計をされたアプリケーションなのかで良い命名方法は異なると思います。

「共通のロジックである」という理由で追い出すものがユーティリティ関数群のようなものであればXUtility.dllなどになるかもしれませんし、コアなビジネスロジックであれぼXCore.dllとなるかもしれません。デザイン、というのはよくわかりませんが、UI部品のことであればXUIComponent.dllとかでしょうか？

BluOxyさんの仰るとおり「名前から中身が想像できる」のは非常に大事だと思いますが、万人が理解できる名前というのも非常に難しいので、ベストな選択肢を提示するのは困難です。
管理上の必要を満たすのであれば、ある程度の妥協も必要になると思います。

命名は奥が深く、なかなかこういう限られた場所で語るのも難しいです。
命名に関する書籍も色々あります（つまりそれだけ語る内容が多い）ので、探されてみてはいかがでしょう。

Comments

[LaLaLand]

ありがとうございます。
確かに、その通りですね。

共通Xの方には、製品の名前をそのまま付けることにしました。
また、共通Yの方には単純にCommonとだけ付けました。大きくなってきたら分けることにします。

ありがとうございます。