ActionScript 2 では、NaturalDocsを使用しました。ただし、PHP のサポートはかなり貧弱です。これまでdoxygenとphpDocumentorを見てきましたが、私の意見では、それらの出力はかなり醜いです。PHP の自動ドキュメント生成の経験がある人はいますか? javadoc スタイルのタグを使用できるようにしたいと考えています。これらのタグは、記述が短く、覚えやすいものです。
53514 次
9 に答える
22
アピジェン
ApiGen は、PHP 5.3 名前空間、パッケージ、ドキュメント間のリンク、PHP 標準クラスと一般ドキュメントへの相互参照、強調表示されたソース コードの作成、および PHP 5.4 トレイトの実験的サポートをサポートしています。
DocBlox
http://www.docblox-project.org/
PHP 5.3 互換の API ドキュメント ジェネレーターは、あらゆる規模のプロジェクトと継続的インテグレーションを目的としています。
Zend Framework 2 を完全に解析および変換できる
于 2011-12-31T19:35:53.893 に答える
18
docblockからAPIドキュメントを生成できる2つのよく知られた頻繁に使用されるツールがあります。
- phpDocumentorは、PHPに固有であり、おそらくPHPプロジェクトで最も使用されているツールの1つです。
- Doxygenは、C用ですが、PHP用に使用されている人もいます。
「ガイドライン」について：それはあなたのプロジェクトに依存すると思いますが、少なくとも、私は見ることを期待します：
- メソッド/関数の機能の説明
- パラメータ、
@param type name description of the parameter - 戻り値、
@return type description of the return value - 例外、
@throws type description of the exception that can be thrown
最近のIDE （たとえば、Eclipse PDTなど）がこれらのマーカーを読み取って解釈し、コーディング時にヒントを提供できることは素晴らしいことです;-)
また、ドキュメント以外の目的でphpdocblockを使用するPHPツールはますます増えています。
たとえば、PHPUnitでは、特定のタグを使用してテスト関連のものを指定できます。注釈を参照してください。
于 2009-12-18T05:38:41.153 に答える
6
PHPDocは、Javadocスタイルのインラインコメントの観点から見ると、おそらく同じくらい優れています。PHPXRefも確認することをお勧めします。
于 2009-12-18T05:39:39.467 に答える
6
はい、phpDocumentor（http://www.phpdoc.org/）はPHPautodocsの許容可能な標準ツールです。これは事実上の標準です。
PHPコードを文書化するときは、コードに関する一般的なJavaDocガイドラインに従うことができます。ただし、PHPとJavaは異なる言語であるため、それだけでは不十分な場合があります。
たとえば、PHP関数には戻り型がなく、関数が1つのコンテキストで1つの型を返し、別のコンテキストで別の型を返すことは避けられません（場合によっては望ましい）。Javaで行うことは不可能であるため、JavaDocガイドラインはそれを支援しません。
于 2009-12-18T05:56:51.213 に答える
4
phpDocumentor can output in a style similar to the php.net documentation (and its built in with both smarty and non smarty layouts)
于 2008-10-09T23:11:03.460 に答える
4
PHPDoctor http://peej.github.com/phpdoctor/をチェックしてください。PHP 用のシンプルでありながらフル機能の Javadoc クローンです。
于 2010-12-30T23:22:29.620 に答える
3
Wordpressのコードベースはphpdocタグを使用して文書化されており（これを参照）、一般的にはかなり優れています。ここではphpDocumentorを使用してレンダリングされています。
私が書いたコードのほとんどは、ドキュメントの自動生成について考える必要があるほど十分に充実しているため、.Netで行われているため、ドキュメント作成者の視点をあまり与えることはできません。
于 2009-12-18T05:41:38.243 に答える
1
醜いのが問題なら、スタイルシートをカスタムのものに切り替えるだけです。生成されたものを上書きしたくない場合は、Stylishなどの Firefox プラグインを使用できます。
于 2008-10-09T23:01:15.027 に答える
0
You could edit the template file to add your own stylesheet to override the existing one.
于 2008-10-09T23:23:23.220 に答える