Top > コーディング規約 > ソースの記述位置

ソースの記述位置

今回のコーディング規約は、ソースの記述位置です。
メンバ変数の定義や、publicメソッド、privateメソッドがごちゃごちゃに
ソースの中に配置されていると、やはり全体を眺めるのが面倒です。

ソースコードに、エリア分けを行う

とりあえず、ソースコードに、下記に示すようなエリア分けを示すコメントを
付与して、そのエリア内に、変数定義やメソッドを配置しましょう。

  • 定数定義部
  • スタティック変数定義部
  • メンバ変数定義部
  • コンストラクタ
  • 公開メソッド
  • 非公開メソッド
  • インナークラス
  • setter / getter

ということで、前回までのファイルコピークラスに、エリア分けコメントを
付与してみましょう。

ソースコード全体の行数は多くなってしまいますが、後々のメンテを考えると、
このように分類しておくことにはメリットがあります。

  • 定数や、メンバ変数がどのくらいあるか、直ぐにわかる
  • 外部公開しているメソッドの種類が、分かりやすい
  • setter/getterは、読む必要のほとんどないメソッドなので、隔離する

つまりは、このクラスのソースコードを改修しようとしたときに、大雑把に
どのあたりに手をいれればいいのか、分かりやすくなります。