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

phpの時分秒+cakePHPのupdate

ちょっと小ネタ集になります。 Contents1 PHPで秒→時分秒変換2 cakePHPでのupdate PHPで秒→時分秒変換 PHPで秒数から時分秒に変換するプログラムです。 汎用的かなと思った …

no image

設計業務での改善点など

比較的大規模なプロジェクトの設計段階で思ったことなど。会議など頻繁に開かれると思いますが、聞いているだけだったり、各人が色々なことを喋って内容がまとまっていなかったり・・結局何をやりたいかわからなくな …

no image

php-fpmに関して

今回はphp-fpmに関して。会社のサーバー(このブログが載っているサーバー)がこれ使ってて、メモリをやたら消費しており、設定を見直す必要があったので、リサーチ。 Contents1 php-fpmと …

no image

Cakeでのリレーションについて

いまさらながらCakeのリレーションについての復習。 基本から。 Contents1 基本的なリレーション1.1 1対N1.2 N対11.3 動的な紐づけ 基本的なリレーション 下記のようなテーブル構 …

no image

wordpressのドメイン移行

WordPressのドメイン以降を行いました。 まあ、このブログの直下にエンジニア集客用ブログをおいたんですがね・・・ http://skill-up-engineering.com/gachinko …

アーカイブ