Art of Coding 第5章:一貫性とスタイル
この記事は、ブログシリーズ「Art of Coding」全26回のうちの第7回です。前回はArt of Coding 第4章:保守性と拡張性でした。
なぜコードには「声」が必要なのか
チームに加わった瞬間、少し居心地の悪いことに気づかされます。自分のコードは、もう自分だけのものではないのです。誰かがそれを読みます。誰かがそれを保守します。そしてもしその人が理解できなければ、深夜2時に本番環境をデバッグしながら、あなたのことを恨むでしょう。
この章のテーマはそこにあります。ルールのためのルールではありません。一貫性とスタイルによって、コードベースが一つの声として響くのか、それとも余白で十数人が言い争っているように感じられるのかが決まる、という話です。
良いコードスタイルを支える三つの柱
本書では、活気あるコードベースと混沌としたコードベースとを分ける、互いにつながり合った三つの実践を探っています。
共通の取り決めとしてのコーディング規約。 以前、インデントが2スペースから8スペースまでばらばらで、同じファイルの中でさえ揃っていないプロジェクトをレビューしたことがあります。変数名も、冗長なものから暗号のようなものまでさまざまでした。動いてはいましたが、読んでいると、会話の途中で方言が次々と切り替わるような感覚でした。答えは「完璧な」規約を見つけることではありません。何らかの規約を持ち、それを守り続けることです。規約があれば、頭は細かな判断から解放され、本当に大切な仕事にエネルギーを残しておけます。
門番としてのリンターとフォーマッター。 思い切った考えを一つ。退屈な部分は機械に任せてしまいましょう。良いリンターは、人間が見落としてしまう怪しいパターンを見つけてくれます。フォーマッターは、スタイルをめぐる議論が始まる前にそれを消し去ってくれます。これは管理の話ではありません。解放の話です。私が一緒に働いていたチームでは、セミコロンを自動化した瞬間に、セミコロンをめぐる言い争いがぴたりと止みました。
敬意としての、その言語らしいコード。 JavaからPythonに移ったとき、私はJavaの習慣をすべて持ち込んでしまいました。コードは「動いて」いましたが、どこかよそ者のように見えました。同僚たちは丁寧に、あまり「Pythonic」ではないね、と言ってくれました。その言葉は、ずっと私の心に残っています。どの言語にも文化があり、考え方があります。その言語らしいコードは、その文化を尊重します。その言語を話す開発者にとって、わが家のように感じられるのです。
AIは何を変えるのか
AIは新たなひねりをもたらします。モデルは一貫性のないコードを生成することがあります。ある関数はsnake_caseで、次の関数はcamelCaseで、といった具合に、何のためらいもなくコーディングスタイルを混ぜてしまうのです。しかし、ここにチャンスがあります。明確な規約が整っていれば、AIを自分たちの声に合わせるよう導くことができます。新しいエンジニアをオンボーディングするのと同じように、機械を導けばよいのです。
下田 昌平
開発に関するインプットをアウトプットしています。カテゴリー
タグ
検索ログ
開発・技術相談
システム開発や技術検証、要件定義の作成、アーキテクチャ設計、 テスト設計、運用設計まで、一気通貫で支援しています。 企画段階の「まず相談したい」レベルから、実装・運用まで 幅広く対応できますので、お気軽にお問い合わせください。
お問い合わせ