問題タブ [phpdoc]

私はCでPHP拡張機能を作成しましたが、ユーザーが拡張機能を呼び出すときにPHP IDE（この場合はNetbeans）でインラインドキュメントを取得できるように、PHPdocドキュメントを作成したいと思います。

理想的には、実装とドキュメントを一緒に保つために、CコードにPHPdocsを埋め込むことによってこれを実行したいと思います。

PHPdocsをCに埋め込むことが可能であると仮定すると、ドキュメントをNetbeansに表示するには（PHPコードのPHPdocsの場合と同様に）、どのような追加の手順が必要ですか？

編集：

O'Reilly Programming PHPは、ドキュメント生成で使用されているコメント形式を指し/* {{{ protoますが、参照されているスクリプトがPHPdocsを生成するかどうかはわかりません。

{{{proto行は、エディターでの折りたたみに使用されるだけでなく、PHPドキュメントプロジェクトの一部であるgenfunclistおよびgenfuncsummaryスクリプトによっても解析されます。拡張機能を配布する予定がなく、PHPにバンドルするという野心がない場合は、これらのコメントを削除できます。

この例では:

$foo がクラス Foo でなければならないことを示す方法は?

私はEclipse+PDTで開発しています。コードにphpdocコメントを追加してきましたが、実際にはEclipseで結果のドキュメントを生成することはありませんでした。どうすればよいですか？Eclipseにいくつかの機能がありますか、それともドキュメントの生成を外部で行う必要がありますか？

最初の試みでは、システム/アプリケーション/モデル、システム/アプリケーション/コントローラー、システム/アプリケーション/ヘルパー、およびシステム/アプリケーション/ライブラリーのみを含めました。これらのフォルダーを選択したのは、これらのフォルダーには、将来の参照用に適切に文書化するコードが含まれていると思うからです。他にどのフォルダを含める必要があると思いますか?

PHP/phpDocumentor/Eclipse 用の netbean の Javadoc 自動コメント ツールに似たものはありますか? netbeans の実装では:

A dialog pops up and allows you to run through all the members of your class and enter comments, which are added to the source file. It even verifies that there are no parameters you have not accounted for, so you can be sure that your comments are complete.

Ideally this would be standalone software, but plugins are OK too :)

p.s. netbeans 6+ auto comment was moved/renamed. Now in "Tool->Options", Tab: "Java Code", Javadoc: "Hints"

edit: screengrab of the original Netbeans tool:
_{(source: vsj.co.uk)}

私は phpdocumentor を取得して、作成するドキュメントを補足するために DocBook チュートリアル形式を使用できるようにするために、できる限りのことを試みています。

1. 私はエクリプスを使用しています
2. OSXマシンにPEAR経由でphpDocumentorをインストールしました
3. PHP クラスからコードを実行して自動生成できます
4. チュートリアルがフォーマットされません - 解決策が見つかりません

コード内で参照されているパッケージと同様の名前を使用して、サブフォルダー内のファイル構造全体に .pkg サンプル ファイルを移動しようとしました。 .pkg およびその他の DocBook ファイルは、ドキュメント化されているコードと、それらが phpdoc をトリガーしてフォーマットする方法に関連しています。

重複の可能性:
GET/POST パラメーターを文書化するための標準はありますか?

理にかなった方法で phpdoc を介してリクエストパラメーターを文書化する最良の方法を見つけようとしています。具体的には、GET/POST を介してパラメーターを受け取る Zend Framework コントローラー アクションがいくつかありますが、機能的なパラメーターではありません。これは理にかなっていますか？

このメソッドのドキュメントを生成した場合、URL 文字列を介してこのメ​​ソッドに「order」と「dir」を渡すことができるという兆候はありません。するだけのほうが理にかなっていますか

代わりに @var を使用する必要がありますか?

考えは大歓迎です。

私の最初のオープン ソース プロジェクト (恥知らずなプラグイン: mtChart ) では、現在 2 種類のドキュメントがあります。

• コード内の phpdoc-comments から Doxygen によって生成された HTML ファイル
• Google Code の wiki ページ (または簡単に言えば、追加のテキスト ファイル)

Doxygen ファイルは非常に優れていますが、チュートリアル、例、システムの概要、ロードマップなどの「ハイレベル」ドキュメントを追加する可能性がありません。

これら 2 つを自動化された方法で組み合わせるにはどうすれば、残りのテキストを何らかの形で自動的に含めてコード ドキュメントを最新の状態に保つことができますか?

(必要に応じて、Doxygen から離れるつもりです。)

いくつかの PHP 関数が上部にコメントされているのを見たことがありますが、私には不明な形式を使用しています。

私の IDE では、@param や @return などをドロップダウンで選択できるので、どこかに文書化する必要があります。Google で検索してみましたが、検索に @ 記号が含まれません。

このコメント形式とは何ですか? また、それに関する情報はどこにありますか?