LoginSignup
7
2

More than 5 years have passed since last update.

個人的に守って欲しい「3つのコーディング規約」

Posted at

はじめに

時にコーディング規約はめんどうですが、
何か一定の指針がなければカオスになりがちです。

守らなくてもいいけど、できれば守って欲しい、
極めて個人的な3つのコーディング規約をご紹介します。

3つのコーディング規約

ネストは3つまでに収める

深いネストはコードの可読性を低めます。

クラスやメソッドのネストは無視してもかまいませんが、
if文やfor文などのネストは3つぐらいにしましょう。

1メソッドは画面に収める

具体的な数値だと、フォントサイズによりますが、
行数は40行ぐらいにしましょう。

1画面で見られない処理コードは可読性が低いと思います。

1行で見えるように収める

PCの大画面化に合わせてか、
最近はとても長いコードを書く人が増えた気がします。

私のテキストエディタは「右で折返す」設定がオンなので、
折返しが起こらない長さでコードを書いていただきたいです。

「右で折返す」設定がオフの場合は、
サイドバーが出ない長さを目安に書いてください。

1行の文字数は半角80文字ぐらいでお願いします。

さいごに

この3つの規約は、もともと1つの規約でした。

それは「画面に収まるようにコードを書いて」というものです。

しかし、これだと抽象的すぎて伝わらないので、
3つの「収める」規約にわけて具体的な数値目標にしました。

ちなみに、このコーディング規約は、
私が考えた理想のコーディング規約に沿って書いています。

何かの参考になれば幸いです。

7
2
3

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
7
2