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

CakePHP2系でのテスト処理

cakePHP2系でのテストの処理について。 PHPでのテストといえばphpunitが有名かと思います。cakePHPでも標準でphpunitがはいっており、ユニットテストを行うことができます。 Co …

no image

PHPでの画像トリミング&縮小

PHPにて画像のトリミング&縮小処理があったんで、メモ。 仕様は下記の通り 16:9の画像(解像度:5168×2907)を高さを維持して4:3にする。つまり横長だった画像比を変えるので、両サイドを取り …

no image

CakePHP3 Unitテスト モデル編

長らくやろうやろうと思っていながら手がつかなかったCakePHP3のユニットテストについて。 以前にも何らかのエントリーで書いたのですが(下記参照)、モデル系はなかなかやらなかったので、これを機に説明 …

no image

composerでのライブラリ登録

今回はPHPのパッケージ管理ツールであるcomposerへのライブラリ登録を。 Contents1 ライブラリの作成2 packagistへの登録3 呼び出す側3.1 composer.json3.2 …

no image

CakePHPでのプレフィックスルーティング

cakePHPではルーティングがデフォルトでは/コントローラ名/アクション名となります。 ところが管理画面などはadmin/コントローラー名/アクション名などと変則的なURLにしたいことも多いでしょう …