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

jQuery modalダイアログについて&重複時間処理

Contents1 jqueryモーダルダイアログ1.1 あらかじめ読み込むライブラリ1.2 ソース本体1.2.1 Html側1.2.2 Javascript側1.2.3 参考リンク2 重複時間につい …

no image

phpdocument

今回はphpのdocument生成ツールについて。 Contents1 phpdocument1.1 インストール1.2 使い方1.3 参考リンク phpdocument https://www.ph …

no image

PHPでのリフレクション

Javaなどでは結構やりましたが、PHPでも動的にインタンス生成→メソッド呼び出しということをやれるとやれることが一気にふえるため、ちょっとメモです。 Contents1 ソース2 参考リンク ソース …

no image

cakePHPでの直SQL

今回はCakePHPにて直のSQLを書く方法を。 cakePHPにて大概の処理はもともと備わっているコマンドでなんとかなりますが、まれに直SQLを書いたほうがらくなこともあります。 書き方その1 [c …

no image

composer global require

composerでのglobal requireに関して。 composerでライブラリを読み込むとき、一般的には下記のどちらかで読み込むことが多いです。 composer.jsonに記述 [cray …