俺的コーディングガイドライン


以前、

良いコードの三カ条なるものを上げた。

どうやったら綺麗なコードが描けるのか?
そのための簡単な三つの心得。

  1. ネストは出来る限り浅くする
  2. 関数やメソッドは出来る限り行数を短くする
  3. 関数やメソッドは目的をシンプルに絞る

良いコードの為の3箇条

こうすることで自然と綺麗なコードになる。
と、自分ながらに考えてみたのだが
最近改めてこの事を考えながらコードを書いていて

何となく

自分なりのルール

ができつつある。

あくまで俺的なコーディング基本規約だけど、
それなりに効果はありそう。

 

俺的コーディングガイドライン

  1. 一つのファイルは可能な限り400行以内にする。
  2. 一つのクラスは可能な限り300行以内にする。
  3. 一つの関数、サブルーチンは30行以内程度にする。最大でも50行程度に収める。
  4. 一行は最大80文字以内、ただし例外は認める。
  5. ネストはif、for含め3層以内で納める。
  6. スコープ範囲は可能な限り狭くする。
  7. 関数名は可能な限り短くする、かつ分かりやすくする。
  8. 変数名は略称で短くする。
  9. それぞれの言語に合わせてそれぞれのlintの基本を守る。

とりあえず、基本編はこんな所で
もちろんあくまでガイドライン。
例外があるのは承知なのだけれど、

これを可能な限り守ってコーディングしたい!

まぁ単なる目標みたいなものかな。
あとは、才能とセンスか・・・
ただ変数名の略称はflake8に引っかかるから微妙かも。

以前教えてもらった格言をここで一つ

「コードは読まれる機会の方が多い」
「読みやすいコードを書け」

例えテクニカルアーティストといえどここは守っていきたいよな。

 

Leave a comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

This site uses Akismet to reduce spam. Learn how your comment data is processed.