1. まとめトップ

きれいなソースコードを書くための条件

きれいなソースコードを書くことはプログラマーの永遠のテーマです。

更新日: 2013年02月03日

29 お気に入り 22447 view
お気に入り追加

この記事は私がまとめました

naochiwaさん

きれいなソースコードとは?

プログラムが汚いとは、語彙の意味があやふやで不安定であること
プログラムがきれいとは、語彙の意味が明確で一貫していること

きれいなコードとは、無駄な構造がなく、体裁が整っていて誰が読んでも分かりやすいことだろう。きれいなコードはシンプルで高速だ。

きれいなソースコードの条件

・インデントが施されている
・選択意図が汲み取れる命名規則に則っている
・コードが短い
・同じ機能である場合は標準の関数やクラスが使われている
・オブジェクト指向やルーチンなど読み手の記憶力を要求しない

「すべてに正しい名前」を求める意志は何を生むか

・そのコード・その部分がやることが明確になる
・「それは何なのか」が一貫する
・スコープが最適になる
・プログラムが「とにかくそう動く」ではなく、意味レベルで整理・洗練される
・コードの凝集度が上がる
・設計が本当に必要な最適解に近付いていく
・複雑さが名前で表現できる範囲に押さえられる
・コードがシンプルになる
・コードの矛盾・ズレ・間違いが排除される
・依存の少ない変更に強いコードになる
・コードの重複が排除される
・汎用な物が抽出され、それを利用する事で、コードがさらに簡潔になる

1.1行の長さを適度にする
2.同じレベルの処理は字下げ位置を揃える
3.複数の処理をできるだけ1行にまとめる
4.シンボルを冗長に 意味をわかりやすくする
5.機能ごとに空白行を挿入する

たくさんソースコードを読んで、テストしやすくすることを意識しながらたくさんソースコードを書くと、きれいなソースコードがかけるようになります。

「美しいソースコード」 とは 「可読性を優位した効率の良いソースコード」である。

「美しいソースコード」を書くために頭を捻っている時間は「コスト」だ。「価値」じゃない。
同様に、「醜いソースコード」の解読やデバッグに費やす時間も「コスト」。

1. 意図を表現
2. 単一責務
3. 的確な名前
4. Once And Only Once
5. 的確に記述されたメソッド
6. ルールの統一
7. Testable

1