hypermkt blog

PHPMD(PHP Mess Detector)を使ってバグ検出2:変数命名編

July 12, 2014

前回の に続いて今回は変数命名について調べました。PHPMD実行時のオプションで namingを渡すことで下記をチェックしてくれます### 短すぎる変数名

  • メンバ変数
  • ローカル変数
  • 引数
  • 最小値 : 3文字

長過ぎる変数名

  • メンバ変数
  • ローカル変数
  • 引数
  • 最大値 : 20文字

短すぎる関数名

クラス名と同名の関数名の使用禁止

  • PHP4の時はクラス名と同名の関数名がコンストラクタとなりましたが、PHP5の場合コンストラクタは__constructになります。

定数の大文字チェック

  • 定数は大文字で宣言すべきなので、小文字だと指摘されます。

getメソッドなのにboolean型を返そうとしている

  • boolean型の値を返したい場合はisXかhasXを利用すべきなので、getでboolean型を返そうとする場合は指摘されます。
  • ただしこのチェックは実際の関数の中をみるのではなくコメント欄と@return booleanをみているので、コメントが記述されていない場合はスルーされます。

試してみる


都内で働くWebアプリケーションエンジニア。主にサーバーサイド。最近はRuby/Railsでコードを書くのが楽しい。