株式会社ラフティ | Time Craft Consulting
Chapter 3
コード内タグ（START / END）運用ルール
このChapterで定義するのは、
判断が及ぶ範囲をコード上で明確に固定するためのルールである。
コード変更そのものよりも重要なのは、
どこからどこまでが、今回の判断による変更かが即座に分かることである。
そのために、
START / END タグを必須とする。
3-1. START / END タグの役割
START / END タグは、
装飾でも、コメントでもない。
判断の影響範囲を示す境界線である。
-
START：この判断による変更が始まる位置
-
END：この判断による変更が終わる位置
この2点で囲まれた範囲のみが、
今回の判断結果である。
3-2. なぜ変更範囲を明示する必要があるのか
コードレビューや障害調査では、
次の問いが最初に発生する。
「どこを見ればよいのか」
変更範囲が曖昧な場合、
-
全体を読み直す必要が生じ
-
影響範囲を推測することになり
-
調査時間が指数的に増える
START / END タグは、
調査の起点を一瞬で決めるための仕組みである。
3-3. タグは判断単位で必ず閉じる
START タグを書いたら、
必ず END タグで閉じる。
-
ネストを許可しない
-
曖昧な途中終了を認めない
判断の範囲は、
必ず一つの開始と一つの終了を持つ。
3-4. ADD / CHG / DEL・管理番号・日付との関係
START / END タグは、
Chapter 1・2 のルールと必ずセットで使用する。
タグには、以下を必ず含める。
-
判断区分（ADD / CHG / DEL）
-
管理番号（Backlogキー）
-
判断日付
例：
// [START][CHG][BL-1234][2024-09-15]
変更されたコード
// [END][CHG][BL-1234][2024-09-15]
これにより、
-
どの判断か
-
いつの判断か
-
どこまで影響するか
が、コードだけで完結する。
3-5. タグ外コードは今回の判断対象外とみなす
START / END タグの外側にあるコードは、
今回の判断とは無関係である。
-
ついで修正
-
まとめて整理
-
気づいたから直す
これらは一切認めない。
別の判断が必要であれば、
別の管理番号・別のタグ範囲として定義する。
3-6. 実装者の自由を制限する理由
このルールは、
実装者の自由を奪うためのものではない。
調査時に他人が考え直さなくて済む状態を作るためである。
-
書いた本人でなくても
-
数ヶ月後でも
-
引き継ぎ後でも
判断範囲が即座に分かることを最優先する。
まとめ
-
START / END は判断範囲の境界線である
-
変更量ではなく、判断範囲を示す
-
タグは必ず閉じ、ネストしない
-
ADD / CHG / DEL・管理番号・日付と必ずセット
-
タグ外は今回の判断対象外とする
Chapter 1：ADD / CHG / DEL による判断区分ルール
Chapter 2：管理番号（Backlogキー）・日付付与ルール
Chapter 3：コード内タグ（START / END）運用ルール