質の高いプログラムを書くためのアドバイス

ホーム > 芸術的なプログラマ > 5つの書き方 その1 統一性

芸術的なプログラマ

:: artistic programmer ::

5つの書き方 その1 統一性

プログラムの「書き方」を統一することで、きれいに見えるだけでなく、読みやすくもなります。

それに加えて、他人に見せたときに、
「きれいにまとまってる」
「読みやすくて、処理の流れがはっきりわかる」

と言われるようになります。

また、自分自身に対しても良い効果が得られます。

きちんと「書き方」を統一してあれば、将来修正が発生したときなど、対応するところが一目でわかるようになります。

あなたのプログラムには、どの程度の統一感がありますか?
最低でも次のものは統一しましょう!

「コメント」 「変数の名前」 「関数(またはメソッド)の名前」

○コメント
多くのプログラミング言語には、コメントから関数などの仕様書を作成してくれるツールがあります。(Java の javadoc のように)
そのツールで決められた書式でコメントを統一します。
○変数の名前
「ハンガリアン記法」というのがありますが、これに従う必要はありません。
自分、またはチーム内の命名規則に従って統一します。
○関数の名前
機能を示す接頭語を統一します。
(たとえば、設定用であれば set、作成用であれば create

他に「インデント」を統一してもいいですが、最近では「インデント」をそろえてくれるソフトがありますので、特に気を付ける必要はありません。

▼ 「統一性」を考えた書き方のポイント

  • コメントの書式を統一する
  • 変数を命名規則に従って統一する
  • 関数の接頭語を統一する
  • インデントはソフトを使って統一する

Next 5つの書き方 その2 高速性


ホーム > 芸術的なプログラマ > 5つの書き方 その1 統一性

Copyright (C) 2005-2007 Noto Watabe. All rights reserved.
e-mail:wmh@always-pg.com