再使用可能なコンポーネントの命名ガイドライン
再使用可能なコンポーネントでは以下のような一般的な命名ガイドラインに従います。
• コンポーネントに名前空間を指定できます。コンポーネント名の前に会社名をプレフィックスとして追加できます。例: <company_name>.<component_name>
PTC のコンポーネントには <company_name>.<component_name> という命名規則が使用されています。たとえば、コンポーネント名は PTC.* で始まります。
• 同じコンポーネントに属するローカライズトークンには、完全なコンポーネント名がプレフィックスとして含まれていなければなりません。
• 同じコンポーネントに関連するすべてのエンティティが同じタグを持ち、同じプロジェクトに属していなければなりません。それらの名前には同じプレフィックスが付いていなければなりません。
• 意味のある名前をエンティティに付けます。
• あいまいな名前や長いエンティティ名は避けます。
• 作成したすべてのエンティティにわかりやすい説明を含めるようにします。
• 名前が競合しているサービスまたはプロパティの名前を変更します。たとえば、2 つの Thing Shape のサービスまたはプロパティの名前が同じであるとします。これらの Thing Shape が同じ Thing Template によって実装された場合、名前の競合が発生します。
• コンポーネントおよびそのエンティティ名の既存のプレフィックスを一元管理できます。これは名前の競合を回避するのに役立ちます。