Skip to content

Instantly share code, notes, and snippets.

@MasayukiFukada
Last active October 24, 2016 07:30
Show Gist options
  • Save MasayukiFukada/ff04bbc21b0192df04127728efe761ba to your computer and use it in GitHub Desktop.
Save MasayukiFukada/ff04bbc21b0192df04127728efe761ba to your computer and use it in GitHub Desktop.
コーディング三原則

コーディング三原則

コーディング時は下記三点に留意すること

  • 繰り返し行う作業は自動化する
    • ビルド、デプロイ、静的解析、テストを簡単に、漏れなく行えるようにする
    • ドキュメントなども生成可能な部分は生成する
  • 分かりやすく適切な、良い名前を付ける
    • 変数、メソッド、クラスなど、命名するもの全てに注意を払うこと
    • 名前が思いつかない場合、曖昧な処理や多くの処理をしていないか確認する
  • 短く、少なく、シンプルに書く
    • 既存のライブラリや処理を使い、自分で作り込むことを減らす
    • 同じ処理は1箇所にまとめる。但し、似たような処理を無理にまとめる必要は無い
    • ネストやステップ数を減らす
    • コメントを必要とするコードを減らす
    • メソッドの引数を減らし、簡素なインターフェースにする
    • 処理しやすいデータ構造にする
    • テスト可能なコードを書き、また実際にテストコードを書く
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment