phpDocumentorでドキュメントの自動生成
javaにはjavadocと言う、ソースファイルからjavaのリファレンスマニュアルを生成してくれるコマンドがありますが、phpにも同様のものとしてphpDocumentorがあります。これはPEARパッケージの１つとして提供されていて、PEARを導入していれば簡単にインストールが可能です。 phpDocumentorの特徴としては、ドキュメントのoutput形式として、下記のようなフォーマットがサポートされています。 html(複数のテンプレートから選択が可能) PDF Windows Help インストールはpearコマンドで簡単にインストール出来ますが、memory_limitがデフォルト値(8M)のままだとメモリー不足でインストール出来ませんでした、php.iniを修正してmemory_limitを16Mに増やせば問題なくインストール出来きました。 ;;;;;;;;;;;;;;;;
PHPの開発環境を構築する（その6）： PHPDocumentorを試す | 悠雀堂ブログ
Javadoc（あるいはDoxygen）のように、PHPにもPHPDocumentorというAPIドキュメントを作ってくれるツールがあります。（DoxygenもPHPに対応しているようですが、PHP界ではこちらのほうがメジャーなようです。） 本稿では、PHPDocumentorをインストールして、実際に利用してみます。 （2014年12月23日追記：Pleiades All in One Eclipse 4.4 Luna PHP fullでのインストールについて追記しました。） （2015年2月26日追記：インストール方法については「Composerによるツールのインストール」を起稿しました。こちらをご参照下さい。） はじめに Eclipse+PDTを使っていると自動的にPHPDoc形式のコメントを生成してくれて便利です。 しかし実際にレポートを生成してみないと、コメントの仕方もわかりませ
phpDocumentorの書き方 - Qiita
phpDocumentorの書き方ってこれ！っていうベストプラクティスがなくて（ドキュメントとはそういうものなのかもしれないけど…）、毎回試行錯誤して、フォーマットを考えるだけでも時間を取られるので、一度自分なりのフォーマットをまとめたいと思います。 今回は、クラスとメソッドについてまとめています。 プロパティについても書いたほうがドキュメントとしてはよいと思うのですが、プロパティまで書き出すとなかなか継続出来ない（ダメ人間です）ので、追々。。 ちなみに、CakePHPをやんわり想定しています。 では、まずクラスについて。 クラス：フォーマット /** * [区分]クラスの概要 * * クラスの詳細 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。 * 全体での共通ルールとか仕様を書く。 * * @access アクセスレベル * @author 名前 <メールアド
【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ
関数/メソッドの場合 例文 /** * aaaの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ function aaa($arg,$arg2){} 型 string integer object(オブジェクト) array mixed(いろんな型が返る場合), resource(リソース型) 変数/define定数 /** * 説明 * @see 関連関数 */ のように書きます。 クラスの場合 /** * クラスの説明 * * @package パッケージ名：ここは、自分でうまく分類作れれば見やすくなる * @author 作った人 * @since PHP 5.3 PHPのバージョンとかいれときます？ * @version 1.0.1 */ DocBlockとは？
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
