SalesforceにおけるWebサービスコールアウトのテスト完全ガイド

日付:
0

Salesforce プラットフォームでの統一された命名規則

日付:


Force.com プラットフォームでの開発における命名規約のベストプラクティス

Salesforce での開発では、読みやすく保守しやすいコードと設定を維持するために、統一された命名規約を採用することが重要です。以下に、主要な命名規約とそのベストプラクティスを説明します。

1. オブジェクトとフィールド

カスタムオブジェクト

  • 命名規則:
    • カスタムオブジェクトはビジネスコンテキストに即した簡潔で説明的な名前を付ける。
    • 単数形を使用する（例: `Invoice`、`Product`）。
  • 開発者名:
    • API 名には PascalCase を使用し、末尾に `__c` を自動付与（例: `Invoice__c`）。

カスタムフィールド

  • 命名規則:

    • フィールド名はオブジェクトのコンテキストに合った具体的な名前を使用。
    • CamelCase で記述（例: `CustomerName__c`）。
    • ユーザーインターフェース用のラベルは読みやすく単語間をスペースで区切る（例: `Customer Name`）。

  • 推奨例:

    • `OrderDate__c`: 注文日を表すフィールド。
    • `TotalAmount__c`: 合計金額を表すフィールド。

2. Apex クラスとトリガー

Apex クラス

  • 命名規則:
    • クラス名は PascalCase を使用（例: `InvoiceProcessor`、`OrderManager`）。
    • 特定の目的を持つクラスの場合、役割を明確にする接尾辞を付ける。
      • 例:
        • コントローラー: `AccountController`
        • ヘルパー: `AccountHelper`
        • サービス: `PaymentService`
        • テスト: `AccountControllerTest`

トリガー

  • 命名規則:
    • `{Object名}{動詞}` の形式を使用（例: `AccountTrigger`）。
    • トリガー内のロジックはクラスに委譲して、トリガー自体は軽量化する。

3. Visualforce ページと Lightning コンポーネント

Visualforce ページ

  • 命名規則:
    • PascalCase を使用し、ページの目的を名前で明確にする（例: `InvoicePage`、`CustomerDetails`）。

Lightning コンポーネント

  • 命名規則:
    • ケバブケース（小文字とハイフン区切り）を使用（例: `invoice-list`）。
    • フォルダー名とコンポーネント名を一致させる。
      • 例: `customer-details` コンポーネントは `customer-details` フォルダーに保存。

4. レコードタイプ

  • 命名規則:
    • コンテキストを明確にするため、オブジェクト名をプレフィックスとして使用（例: `Account_Business`、`Account_Personal`）。
    • ラベルにはユーザーにわかりやすい説明を含める（例: `Business Account`、`Personal Account`）。

5. パーミッションセットとプロファイル

  • 命名規則:
    • パーミッションセット:
      • `{目的}-{対象オブジェクト}`（例: `ReadOnly-Account`、`Edit-Contact`）。
    • プロファイル:
      • ロールまたは職務に応じた名前を使用（例: `SalesManager`、`SupportAgent`）。

6. カスタムラベル

  • 命名規則:
    • SnakeCase を使用し、内容を明確にする（例: `Error_Message_LoginFailed`、`Button_Save`）。
    • ラベルは翻訳や再利用を考慮して設計。

7. その他のリソース

バッチクラス

  • 命名規則:
    • `{目的}Batch` を使用（例: `OrderProcessingBatch`）。

キューと共有ルール

  • 命名規則:
    • 対象のオブジェクトと目的を含める（例: `Lead_Queue`、`Case_SharingRule`）。

ベストプラクティス

  1. 一貫性を保つ:
    • 全チームで同じ命名規約を適用し、レビュー時に確認する。
  2. 説明的な名前を使用:
    • 名前を見るだけで役割や目的がわかるようにする。
  3. 略語は避ける:
    • 必要以上に省略せず、読みやすさを優先する。
  4. コメントとドキュメントを活用:
    • 複雑なコードや構造には詳細な説明を追加。

コメント

コメントを投稿