自動PHPドキュメントの生成？
ActionScript 2の場合、私は NaturalDocs を使用しました。ただし、PHPのサポートはかなり貧弱です。私はこれまで doxygen と phpDocumentor を見てきましたが、それらの出力は私の見方ではかなり醜いです。 PHPの自動ドキュメント生成の経験はありますか？私はjavadocスタイルのタグを使用できるようにしたいのですが、それらは書くのが短く、覚えやすいです。
ApiGen
ApiGenはPHP 5.3名前空間、パッケージ、ドキュメント間のリンク、PHP標準クラスと一般ドキュメントへの相互参照）、ハイライトされたソースコードの作成と実験的サポートをサポートしています。 PHP 5.4の特性。
DocBlox
http://www.docblox-project.org/
PHP 5.3互換のAPIドキュメントジェネレーター。あらゆる規模のプロジェクトと継続的統合を目的としています。
zend Framework 2を完全に解析および変換できる
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 など）、これらのマーカーを読み取って解釈し、コーディング時にヒントを提供できます;-)
また、ドキュメンテーション以外の目的でphp docblockを使用するPHPツールがますます増えています。
たとえば、PHPUnitでは、特定のタグを使用してテスト関連の要素を指定できます Annotations を参照してください。
PHPDocは、Javadocスタイルのインラインコメントに関しては、おそらくあなたがそれと同じくらい優れているでしょう。 PHPXRef もご覧ください。
はい、phpDocumentor（ http://www.phpdoc.org/ ）は、PHP autodocsで使用できる標準ツールです。これは事実上の標準です。
PHPコードを文書化するときは、コードの一般的なJavaDocガイドラインに従うことは許容されます。ただし、PHPおよびJavaは異なる言語です。
たとえば、PHP関数には戻り値の型がなく、関数が1つのコンテキストで1つの型を返し、別のコンテキストで別の型を返すことは避けられない（そして望ましい場合もあります）。JavaDocガイドラインはありません 'それはJavaで行うことが不可能であるため、これを支援するつもりです。
PHPDoctor http://peej.github.com/phpdoctor/ を確認してください。これは、PHPのシンプルでありながら完全な機能を備えたJavadocクローンです。
phpDocumentorは、php.netドキュメント（およびsmartyレイアウトと非smartyレイアウトの両方に組み込まれている）と同様のスタイルで出力できます。
Wordpressコードベースはphpdocタグを使用してドキュメント化されており（ this を参照）、通常はかなり良好です-レンダリングされます here 使用 phpDocumentor 。
私が作成するコードのほとんどは、ドキュメントの自動生成について考える必要があるほど十分に充実しているため、.NETで行われるため、ドキュメント作成者の視点をあまり提供できません。
醜いことが問題なら、スタイルシートをカスタムのものに切り替えるだけです。生成されたプラグインを上書きしたくない場合は、 Stylish のようなFirefoxプラグインを使用できます。
テンプレートファイルを編集して独自のスタイルシートを追加し、既存のスタイルシートを上書きできます。