code-style

コードスタイルのルール

• 関数は小さく保ちます。複数の役割を担っている場合や、読みやすくするためにセクション分けが必要な場合は、関数を分割します。
• 可能な限り、ファイルは300行未満に保ちます。任意の階層で分割するのではなく、責務に応じて分割します。
• 関数をあちこちに分散させるより、オブジェクト指向のコードを優先します。
• 高レベルの公開関数はファイルの先頭近くに配置し、低レベルのユーティリティは末尾に配置します。
• 簡潔で平易な英語のコメントを書きます。意外な動作をする理由を説明し、自明なコードを説明するのは避けます。
• 具体的な用途が繰り返し現れるまでは、抽象化を追加しません。