Claude Code CLIで実装計画レビューの改善ループを回す。実装計画ファイルと要件ファイルを指定し、Claude Codeにレビューさせ、指摘をトリアージして計画を修正し、再レビューする。
The English summary is being prepared. Showing the original description.
コードの識別子(変数・関数・メソッド・クラス・型・ファイル)に名前を付けるときに使う。get の濫用をやめ、何をして値を得るのかが名前から読み取れる状態にする。実装時と、実装計画でメソッド名・クラス名を決めるときの両方で使う。
The English summary is being prepared. Showing the original description.
Review the instructions the agent will receive before you install.
名前は、そのコードを読む全員が最初に読む説明文である。名前が処理を語らなければ、読み手は本体を読むまで何も分からず、コストも副作用も見誤る。
references/verbs.md から選ぶ。references/modifiers.md を見る。if の条件に置いて読む。get を新しく書かない「取得する」は処理の内容を何も語らない。データベースを引くのか、計算するのか、保持済みの値を返すのか、外部サービスを呼ぶのかが名前から消え、呼び出し側がコストと失敗の可能性を見誤る。
何をして値を得るのかを動詞にする。
| やること | 動詞 |
|---|---|
| 保存先から読み込む | load |
| ネットワーク越しに取りに行く | fetch |
| 条件に合うものを探す | find / search |
| 一覧をまとめて返す | list |
| 材料から組み立てる | build / compose |
| 計算して求める | calculate / count |
| 複数の材料から1つに決める | resolve / determine |
| 別の形に変換して返す | to〜 / convert |
| 中から一部を取り出す | extract |
| 無ければ作って返す | findOrCreate |
例外は適用範囲に挙げた2つ(言語機能としてのアクセサ、既存ライブラリが定めた名前)だけ。それ以外で get を書きたくなったら、手順1に戻って処理を1文で説明し直す。
軽い名前(値を返すだけに見える名前)の中に、入出力・ネットワーク通信・繰り返し処理を入れない。逆に、読み込むだけの処理に重い印象の動詞を付けない。名前と実際のコストがずれると、呼び出し側がループの中で呼んでしまう。
Product(商品)のように広い名前は、予約・注文・在庫・発送のあらゆるロジックを引き寄せ、1つのクラスが肥大する。何の関心事を扱うのかを名前に入れる。
Product → ReservedItem(予約) / StockItem(在庫) / ShippingItem(発送)次の語は、責務が定まらないまま何でも入る器になりやすい。使う前に、何をするものかを名詞で言い直す。
| 避ける語 | 直し方 |
|---|---|
〜Manager / 〜Controller(MVC の Controller を除く) | 何を管理するのかを動詞化して分割する |
〜Util / 〜Helper | 対象となる型の名前を冠した専用クラスにする |
〜Data / 〜Info / 〜Item / 〜Type | 外して意味が通るなら外す。通らないなら中身が定まっていない |
data / result / temp / flag | 実際に入っているものを書く(isSuccess / newId / mappedRows など) |
if の条件として英文になる形にする判定基準は1つ。== true を付けないと文として成立しない名前は使わない。
| 型 | 例 |
|---|---|
is + 形容詞/過去分詞 | isEmpty / isChanged |
has + 名詞/過去分詞 | hasObservers / hasSent |
can + 動詞の原形 | canUpdate |
should + 動詞の原形 | shouldRetry |
needs + 名詞/動詞 | needsMigration |
| 三人称単数の動詞(+名詞) | exists / contains / existsError |
避ける形は3つ。check〜(真のとき何が起きるのかが読めない)、is + 動詞の原形(isFail ではなく isFailed)、原形の動詞 + 名詞(existError ではなく existsError)。
詳細と反例は references/booleans.md。
check / change / process / handle / manage / do は、何が起きるのかを読み手に想像させる。実際の動作を書く。
checkUser → validateUser / userExists / isUserActivechangeStatus → activateUser / cancelOrder / markAsReadprocessOrder → chargeOrder / shipOrder比較する compare も結果の意味が読めない。equals / contains / isOlderThan のように、判定結果が名前で決まる形にする。
片方だけ別系統の語を使うと、対応関係が読めなくなる。
add / remove、insert / delete、create / destroy、open / close、start / stop、enable / disable、show / hide、lock / unlock、push / pop、connect / disconnect、attach / detach、acquire / release、encode / decode、publish / subscribe
一文字の変数名と、その分野で確立していない略語を使わない。nm は name か number か読み手には分からない。
例外は、ごく短い範囲のループ変数(i など)と、確立した略語(id / url / http / db / json)。
Iterable / Closeable)か、役割を表す名詞(〜Repository / 〜Sender)にする。buttons の要素は button)。onCompleted / beforeUpdate / afterSave)。get で始まる新しい名前が残っていないかif の条件に置いて読んだとき、英文として成立するかcheck / change / data / result / temp / flag が残っていないかfetch と load を同じ意味で併用していないか)references/verbs.md — 動詞の使い分け。値を得る/作る/保存する/消す/探す/変換する/検査する/非同期/コレクション操作。references/booleans.md — 真偽値の命名6型と反例3型、否定形の扱い。references/class-names.md — クラス・インタフェースの役割を表す名詞。層ごとの語彙と、避けるべき名前。references/modifiers.md — 修飾語。時間軸・階層・状態・数量・不確実性・注意喚起。以下を突き合わせて整理した。原典に当たる必要が生じたときはここを見る。
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Claude Code CLIで実装計画レビューの改善ループを回す。実装計画ファイルと要件ファイルを指定し、Claude Codeにレビューさせ、指摘をトリアージして計画を修正し、再レビューする。
The English summary is being prepared. Showing the original description.
Claude Code CLIでGitHub PRのコードレビューループを回す。PRのURLを指定し、Claude Codeにレビューさせ、指摘をトリアージしてコードを修正し、再レビューする。PRにリンクされたIssue等は必読として機械的に検証する。
The English summary is being prepared. Showing the original description.
コード・テストコード・コミットログ・コードコメントのどこに何を書くかを決めるときに使う。コードには How、テストコードには What、コミットログには Why、コードコメントには Why not を書き分ける。実装時とコミット・PR 作成時に使う。
The English summary is being prepared. Showing the original description.
Codex CLIで実装計画レビューの改善ループを回す。実装計画ファイルと要件ファイルを指定し、Codexにレビューさせ、指摘をトリアージして計画を修正し、再レビューする。
The English summary is being prepared. Showing the original description.
Codex CLIでGitHub PRのコードレビューループを回す。PRのURLを指定し、Codexにレビューさせ、指摘をトリアージしてコードを修正し、再レビューする。PRにリンクされたIssue等は必読として機械的に検証する。
The English summary is being prepared. Showing the original description.
長大な設計文書・Pull Request・Issueを読み解き、図と短い文を組み合わせた解説HTMLを生成してブラウザで開く。生成したページ内の識別子を指定すると、その項目だけを掘り下げたページも作る。
The English summary is being prepared. Showing the original description.