メインコンテンツまでスキップ

表示名・クラス名の命名の考え方

Next Designでは、メタモデル定義時に、クラス名と表示名を設定する必要があります。

クラス名の命名の考え方

「クラス名」は、エクステンションでの識別名で、同一パッケージ内でユニークな名前となります。 「クラス名」は、パッケージを跨ぐ場合、同じ名前とすることができます。 しかし、エクステンションの、プログラムによる同一判定でクラス名を用いることを考慮すると、 クラス名は、パッケージを跨いでユニークな名前を英語で設定しておくことをおすすめします。 パッケージを跨いでユニークな名前になっていない場合、エクステンションで完全名を指定する必要があるため、注意してください。

クラス表示名の命名の考え方

「表示名」は、モデルエディタやナビゲータでの表示名で、同一パッケージ内でも同じ名前に設定することができます。 「表示名」は、クラス図やプロファイルナビゲータだけでなく、ドキュメントフォームなどのエディタのビューでも表示されるため、モデリングする開発者にとっても識別しやすい名前とするのがよいでしょう。

表示名・クラス名命名例

表示名の命名例

例えば、システムの論理設計と物理設計のそれぞれの工程において、 入力ポート・出力ポートを定義したい場合、「表示名」はそれぞれ、"入力ポート"、"出力ポート"とするのが分かりやすいでしょう。

クラス名の命名例

「クラス名」は識別できること、エクステンションによる判定を行うことを考慮し、英語のユニークな名前としましょう。 例えば、入力ポートの場合、論理設計工程の入力ポートの「クラス名」は"SystemInputPort"、物理設計工程の入力ポートの「クラス名」は"ComponentInputPort"とします。