PHP関数とクラスをインラインで文書化するにはどうすればよいですか？

Question

PHPコードのインラインドキュメントにはさまざまな標準があります。ここで私は、インラインドキュメントによって何を意味するかだし、より良い用語がある場合、私を修正してください：

/** 
* This is the description for the class below. 
* 
* @package my-package 
* @subpackage my-subpackage 
* @author  my-name 
* @version my-version 
* ... 
*/ 
class orderActions { 
... 

インラインドキュメントの最良かつ最も広く受け入れられている形式とは何ですか？このようなドキュメントを自動生成するツールはありますか？それとも手動で行う必要がありますか？

私はマニュアルの作成には興味がありません - 上記のコードタイプを生成する方法、または「インラインドキュメント」を知りたいのですが。

Answer 1

PHPDocは、あなたが投稿したものと同様に、広く受け入れられているPHPドキュメント形式です。

Doxygenを使用すると、ドキュメントを自動生成できます。

編集：コード内にインラインドキュメントを生成するという点では、プロジェクトのために外部に戻ってこれを行うツールを見つけたことはありません。一般的にIDEの領域には、コードを作成するときにテンプレートが生成されます。

Eclipseは実際にはまともな仕事をしています（Eclipseについて私が気に入っている数少ないものの1つです）、Netbeansも同様です。主要なIDEには、このタイプのテンプレート生成を支援する機能があります。

Answer 2

私はそれを完全には利用していませんが、Doxygenはこの作業に有望です。

Java用JavaDocツールに精通している場合は、それに非常に似ています。 Doxygenスタイルを使用し、ソースファイル上でツールを実行してドキュメントを作成します。

Answer 3

通常、私はいくつかのIDEがあなたのためにテンプレートを作成することができると思いますが、あなたは自分でdocblockコメントを書くでしょう。

私は実際にwrite a program, which can trace a running program and detect parameter types and write them back as docblock commentsでした。ちょっとバギーですが、それはちょっとした仕事です。

Answer 4

あなたがコードするものはわかりませんが、私はいくつかのスニペットを使用しています（私はTextmateを使用しています）私は働いているので追加しています。これは私が詳細を記入しているので、私のためにそれをするシステムを信頼する代わりに。

これは、初めに多くの作業だが、私は非常に使いやすくしてはphpdocと互換性documentator作成

Answer 5

長期的にはそれだけの価値があると思われる：

例：

<?php 
    $docs = new QuickDocumenter(); 
    $docs->parseString(" 
    /** 
    * Sanitize string 
    * 
    * @sinse  1.0 
    * @version 1.0 
    */ 
    "); 
    foreach($docs->result() as $doc) 
    { 
     highlight_string(print_r($doc , true)); 
     echo "<hr/>"; 
    } 
?> 

を

Githubの中で参照してください：

https://github.com/olaferlandsen/QuickDocumenter

Bye！

Answer 6

から選択します。

• Doxygen
• phpDocumentator
• Sami
• ApiGen
• CakePHP API docs
• phpDox

Wikipedia article, "Comparison of documentation generators", section "by Language"も参照してください。