skillup

技術ブログ

PHP ドキュメント作成

コード静的解析ツールを使った際の気づきなど

投稿日:

最近のプロジェクトでコード静的解析ツール(phpcs,phpmd)を使った際の気づきなど

  • コードを書きながら常時エディタがチェックするタイプのものでないとまず無理(保存するたびでも無理だし、コミット時の修正などは論外だと思う・・・。)
  • 規約はpsr2が現段階では一番良さげ(2018/5月現在)
  • if文の後のかっこやコメントなど細かいところで色々指摘してくれるのでかなり役立つのでできれば今後は必ず必須にしたい。もっと早くから取り入れるべきだった・・・
  • 入れないと癖でついつい統一性がない恥ずかしいコードを書いてしまうし、特にコメントなどでかなり怒られるので、一定の品質の維持にいいと思う。
  • 規約を全部守るのは無理。規約を守りすぎて他の要素(可読性など)を犠牲にしてしまう。またphpcsとphpmdを同時に入れていると矛盾するルールもあるので物理的に無理。phpmdはルール全部でなく少し外してもいいかも・・

参考リンク

静的解析ツールなど

PHPの静的解析いろいろ

phpmdによるコードチェック

PHP_CodeSnifferによるコードチェック

psr2について

【PHP】PSR-2 Coding Style Guide(コーディングスタイルガイド)

コメントの書き方について

【PhpDoc】コメントの書き方のまとめ

-PHP, ドキュメント作成
-, ,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

Laravel5.4インストール&ルーティング

来月からの仕事でLaravel5.4を使うことになったのでテストがてら自宅で勉強。 とりあえず下記リンクが参考になりました。 Laravel5.4でシンプルなCMSを作るチュートリアル 初めてのLar …

no image

Laravelの認証(独自テーブル仕様)

Laravelで独自の認証をしたいときに少々大変だったのでメモなどを。 *ディフォルトのテーブルはuserで認証項目もemailとpasswordと決まっています。 いじるところが色々ありまして、列挙 …

no image

cakeでのUtilityメソッド

cakeではControllerから呼ぶメソッドはComponent,ModelはBehavior、ViewはHelperに記述するのが一般的です。 ところが、プログラムを書いているとUtility系 …

no image

composerに関して

Javaではライブラリをpomで管理し、mavenを使うことで一括管理していました。 PHPではcomposerがその役割を担っています。 Contents1 composer公式ドキュメント2 co …

no image

laravelのmigrationに関して

DBのカラムの保守などをする場合のmigrationに関して。 ポツポツ使っていたのですが、しっかりまとめてなかったのでここでまとめて見ようかと思います。 カラム定義 [crayon-5d85e520 …