タグ

phpdocに関するokinakaのブックマーク (2)

  • phpDocumentorの書き方 - Qiita

    phpDocumentorの書き方ってこれ!っていうベストプラクティスがなくて(ドキュメントとはそういうものなのかもしれないけど…)、毎回試行錯誤して、フォーマットを考えるだけでも時間を取られるので、一度自分なりのフォーマットをまとめたいと思います。 今回は、クラスとメソッドについてまとめています。 プロパティについても書いたほうがドキュメントとしてはよいと思うのですが、プロパティまで書き出すとなかなか継続出来ない(ダメ人間です)ので、追々。。 ちなみに、CakePHPをやんわり想定しています。 では、まずクラスについて。 クラス:フォーマット /** * [区分]クラスの概要 * * クラスの詳細 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。 * 全体での共通ルールとか仕様を書く。 * * @access アクセスレベル * @author 名前 <メールアド

    phpDocumentorの書き方 - Qiita
  • 続・開発環境のツール周りをちょっと快適にした話 - ぐるなびをちょっと良くするエンジニアブログ

    こんにちは!パンダ大好きエンジニア、宮原です。 前回(開発環境のツール周りをちょっと快適にした話)の記事では、チームで導入した開発支援ツールについて、どんなツールがあるのか、どんな考えで導入したのか、というところをご紹介しました。 開発支援ツール導入後はコードの品質も上がって(潜在バグの低減、保守性の向上)、快適に開発ができるようになりました。現在はCIサーバによる監視も実現できており、もっと開発が快適になりました! 今回は、CodeIgniterというPHPフレームワークに各開発支援ツールをどのように導入し運用しているのか(CIサーバを活用したツール実行方法)をもっと具体的に紹介していきたいと思います。 目次 リポジトリ(ディレクトリ)の構成 各ツール用ディレクトリの詳細 PHP Coding Standards Fixer PHPMD PHPLOC PHPCPD phpDocument

    続・開発環境のツール周りをちょっと快適にした話 - ぐるなびをちょっと良くするエンジニアブログ
  • 1