■良いコードの書き方

• コードを書くまたはレビューするメンバー全員が共通のガイドラインを元にプロジェクトを進行させなければなりません。ある程度コードベースに対する姿勢が統一されていた方がそれぞれのコードの内容が理解しやすいからです。
• 既に使用者がたくさんいる言語であれば、採用するガイドラインはその言語を使う他のプロジェクトで広く採用され、内容についても十分に議論されたものでなければなりません。誰もが大なり小なり自分ルールを持っていますし、それが正しいか間違ってるか、そもそもルールを作ってまで強制されるべきかは一人の視点からは分からないからです。
• あなたがガイドラインを新たに書くとしても、あなたがその言語の生みの親でなければ、ルール一つ一つにはちゃんとパブリックな場で十分考察された事を示す出典が必要です。出典もなく狭い組織の中で採用され十分に考察されてもいない貧弱なルールは公平さや普遍性に欠けます。
• いちばん大事なことですが、ガイドラインに書かれていないことについて修正を要求してはいけません。もちろん採用しているアーキテクチャに沿ってないだとか、要件に関する事は個別に議論されるべきですが、「この記述は省略してこう書くべき」などといった普遍的な書き方の問題は所詮は好みなので、コードレビューの際は「Just a suggestion（こういう書き方もあるというだけなんですが）」と書くだけに留めなければならず、固執してはいけません。間違っても「please (してください)」という言葉が使われてはいけません。

上記はすべて出典もなく議論もされていないため、何の公平さも普遍性もありません。

Permalink | 記事への反応(0) | 20:36

ツイートシェア