あなたにもできること | 悪態のプログラマ
2005年04月29日(金)

あなたにもできること

テーマ:コーディング
私はいつも「読みやすいコードを書け」と言っている。そのためにできることは、決して難しいことばかりではない。

例えば、次のようなソースコードをみると、いつも思うのだ。

private static final String DATA[][][] = {
  {"ringo","gorira","rajio","ondanka","kaimenjoushou"},
  {"5","5","4","7","12"},
  {"K100","J1","U200","X203","W9800"}
};

どうして、こんな風に揃えて書かないのだろうか?

private static final String DATA[][][] = {
  {"ringo", "gorira", "rajio", "ondanka", "kaimenjoushou"},
  {"5"    , "5"     , "4"    , "7"      , "12"           },
  {"K100" , "J1"    , "U200" , "X203"   , "W9800"        }
};

特に、難しいことではないはずだ。

桁を揃えるためにいくつもスペースを打つことは面倒かもしれない(※1)。しかし、自分でコードを読み返してチェックする習慣がある人なら、こうしないと後でもっと面倒なことになるということを知っているだろう(※2)。

もちろん、読みやすさ、読みにくさを決めるのは、こうした桁位置の問題だけではない。しかし、ここでこれ以上の例を挙げる必要もないだろう。

大切なのは、読む人の立場になって考えるということだ。それは、設計書や報告書のような「日本語」を書くときでも同じことだろう。





※1
「タブ」は使わないほうがよい(→「インデントについて考える」 前編後編

※2
チェックしなくてもバグなんか出さないという自信がある人は、そんな自信はただちに捨てなさい。



■関連記事
インデントについて考える 前編
インデントについて考える 後編
まずは丁寧なプログラミングを



プログラミング作法
プログラミング作法
posted with amazlet on 06.04.30
ブライアン カーニハン ロブ パイク Brian Kernighan Rob Pike 福崎 俊博
アスキー (2000/11)
売り上げランキング: 4,300
おすすめ度の平均: 4.75
4 プログラマ以外の人にも
4 くせは治りません・・・
5 洗練されたソースコードに星5つ


Code Reading―オープンソースから学ぶソフトウェア開発技法
トップスタジオ まつもと ゆきひろ 平林 俊一 鵜飼 文敏
毎日コミュニケーションズ (2004/06/01)
売り上げランキング: 30,286
おすすめ度の平均: 4
4 ホップ・ステップ・ジャンプ
3 例題がわかりにくい
4 サブタイトルの方が適切?

argvさんをフォロー

ブログの更新情報が受け取れて、アクセスが簡単になります

コメント

[コメントする]

Ameba人気のブログ

Amebaトピックス