コーディング規約

✎ Apex コーディング規約

Apexコーディングにおける命名規則、バルク処理パターン、CRUD/FLS/Sharing、エラーハンドリング、ドキュメンテーションの規約です。

命名規則 必須

バルク処理（必須） 重要

Salesforceのガバナ制限を遵守するため、バルク処理は絶対に守るべき最重要ルールです。

// NG: SOQLループ
for (MoveIn__c mi : Trigger.new) {
    Account acc = [SELECT Id
        FROM Account
        WHERE Id = :mi.IntroductionFor__c];
}

// OK: コレクション化
Set<Id> accountIds = new Set<Id>();
for (MoveIn__c mi : Trigger.new) {
    accountIds.add(mi.IntroductionFor__c);
}
Map<Id, Account> accountMap =
  new Map<Id, Account>(
    [SELECT Id, Name
     FROM Account
     WHERE Id IN :accountIds]
);

CRUD/FLS/Sharing 重要

セキュリティを確保するため、クラスには必ず with sharing を指定してください。

public with sharing class MyService {
    // with sharing で共有ルールを適用
    // without sharing は正当な理由がある場合のみ使用
}

エラーハンドリング 必須

例外は必ずキャッチし、SystemError__c オブジェクトに記録してください。

try {
    // 処理
} catch (Exception e) {
    SystemError__c error = new SystemError__c();
    error.ErrorMessage__c = e.getMessage();
    error.StackTrace__c = e.getStackTraceString();
    insert error;
}

ドキュメンテーション 推奨

publicメソッドには必ずJavadocスタイルのコメントを付与してください。

/**
 * @description サービス案内を自動作成するハンドラ
 * @param moveIns 対象の入居レコードリスト
 * @return 作成されたサービス案内リスト
 */
public static List<ServiceGuide__c> createServiceGuides(
    List<MoveIn__c> moveIns
) {
    // ...
}

Quick Checklist

• Apex命名規則（PascalCase/camelCase/UPPER_SNAKE_CASE）を把握した
• バルク処理パターン（コレクション化）を理解した
• with sharing の必須性を認識した
• エラーハンドリングパターンを確認した

⚡ LWC コーディング規約

Lightning Web Components（LWC）のファイル構成、命名規則、データ取得パターンの規約です。

ファイル構成 必須

myComponent/
├── myComponent.html        // テンプレート
├── myComponent.js          // ロジック
├── myComponent.css         // スタイル
├── myComponent.js-meta.xml // メタデータ
└── __tests__/
    └── myComponent.test.js // テスト

命名規則 必須

@wire と imperative 注意

データ取得には @wire と imperative の2つのパターンがあります。リアクティブなデータには @wire、ユーザーアクション起点には imperative を使用してください。

// @wire: リアクティブなデータ取得
@wire(getRecord, { recordId: '$recordId', fields: [NAME_FIELD] })
record;

// Imperative: ユーザーアクション起点のデータ取得
async handleClick() {
    const result = await getAccounts();
    this.accounts = result;
}

Quick Checklist

• LWCのファイル構成ルールを確認した
• フォルダ名(kebab-case)とファイル名(camelCase)の違いを把握した
• @wireとimperativeの使い分けを理解した

🔬 テスト規約

Apex/LWCのテスト規約、テスト命名規則、カバレッジ基準をまとめています。テストなしデプロイは禁止です。

Apex テスト 必須

@isTest
private class MyServiceTest {

    @TestSetup
    static void setup() {
        /* テストデータ作成 */
    }

    @isTest
    static void 正常系_サービス案内が自動作成されること() {
        /* テスト */
    }

    @isTest
    static void 異常系_必須項目が空の場合エラーになること() {
        /* テスト */
    }
}

LWC テスト 必須

describe('c-my-component', () => {
    afterEach(() => {
        while (document.body.firstChild) {
            document.body.removeChild(document.body.firstChild);
        }
    });

    it('正常系: 初期表示でタイトルが表示されること', () => {
        const element = createElement(
            'c-my-component',
            { is: MyComponent }
        );
        document.body.appendChild(element);
        const title = element.shadowRoot
            .querySelector('h1');
        expect(title.textContent).toBe(
            'Expected Title'
        );
    });
});

テスト命名規則 重要

カバレッジ基準 重要

Quick Checklist

• Apexテストの基本構造（@isTest, @TestSetup）を把握した
• LWCテストのafterEachパターンを確認した
• テスト命名規則（正常系/異常系）を理解した
• カバレッジ最低75%、目標80%を認識した

📝 コミットメッセージ規約

統一されたコミットメッセージにより、変更履歴の追跡とリリースノートの自動生成が容易になります。

typeの種類 必須

# コミットメッセージの形式
type: 変更内容の要約

# 例
feat: サービス案内自動作成機能を追加
fix: 入居トリガーのNull参照エラーを修正
refactor: AccountServiceのメソッド分割
test: MoveInTriggerHandlerのテスト追加
docs: API仕様書を更新
chore: デプロイスクリプトを更新

Quick Checklist

• コミットメッセージのtype種類を把握した
• 日本語でメッセージを書くことを確認した

🔎 コードレビュー基準

コードレビューは以下の6つのカテゴリに基づいて行われます。全項目をクリアすることがマージの条件です。

レビューフロー 必須

Quick Checklist

• 6つのレビューカテゴリを把握した
• セルフレビューの重要性を認識した
• レビューフローの4ステップを確認した

🚫 禁止事項

以下の項目は絶対に守る必要がある禁止事項です。違反した場合、コードレビューで即リジェクトされます。

CXFields__c の作成禁止 重要

その他の禁止事項 重要

// NG: ハードコードID
String recordTypeId = '012000000000ABC';

// OK: 動的に取得
Id recordTypeId = Schema.SObjectType.Account
    .getRecordTypeInfosByDeveloperName()
    .get('RealEstate').getRecordTypeId();

Quick Checklist

• CXFields__c の直接insert禁止を認識した
• SOQLループ禁止を認識した
• ハードコードID禁止を認識した
• without sharing無条件使用禁止を認識した

🛠 ソリューション選定基準

実装する機能に応じて、適切なソリューションを選定する基準です。

選定フロー 必須

Quick Checklist

• 5つのソリューション種別を把握した
• フローとApexの使い分けを理解した
• VisualForceが新規非推奨であることを認識した

✅ 総合チェックリスト

このページの内容を全て確認したら、以下のチェックリストで振り返りましょう。

• Apex命名規則（PascalCase/camelCase/UPPER_SNAKE_CASE）を把握した
• バルク処理パターンを理解し、SOQLループ禁止を認識した
• with sharing の必須性を理解した
• エラーハンドリングで SystemError__c に記録するパターンを確認した
• LWCのファイル構成と命名規則を確認した
• @wire と imperative の使い分けを理解した
• テスト命名規則（正常系/異常系）を確認した
• カバレッジ最低75%、目標80%を認識した
• コミットメッセージのtype規約を把握した
• 6つのコードレビュー基準を確認した
• CXFields__c の直接insert禁止を認識した
• ソリューション選定基準を把握した