問題タブ [phpdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
php - PhpDocumentor各新しいコメント行の前に*を回避する方法
PhpDocumntorによると、有効なドキュメントに変換するためのコメントの各ブロックは、次のようにカプセル化する必要があります。
各行の前にアスタリスクを強制的に配置することを回避することが可能かどうか（おそらくいくつかの設定を変更することによって）知っていますか。基本的に、PhpDocumentorにこれらのタイプのコメントを受け入れて、ドキュメントに翻訳してもらいたいと思います。
JsDOCとJavaDocは、新しい行の前にアスタリスクを付ける必要がなくなったので、PhpDocumentorも設定を少し工夫することでこれを実行できると思いましたが、Googleではこれについて何も見つかりません。 。
php - トライステートbool戻り値のPHPDocアノテーション
たとえば、アクセスが許可されている場合はtrueを返し、アクセスが拒否されている場合はfalseを返し、アクセスが不確定の場合はNULLを返す関数があります。
@returnphpdocはどうあるべきですか？bool意味がないようです...
php - phpDoc クラス定数のドキュメント
phpDoc のクラス定数を文書化するにはどうすればよいですか? マニュアルを読みましたが、それらについて何も見つかりません。
php - $_SESSIONなどの暗黙的な入力パラメータの文書化
関数が依存している場合は$_SESSION['some_var']、ヘッダーがコメントアウトしてそれを明確にします。どうしますか？テキストと同じように、または何ですか？
それとも@param？
php - phpDocumentor: ドキュメントのみのクラス
私はphpDocumentorについて学ぼうとしています。私は通常、ファイルごとにクラスを配置します。ファイルとクラスを文書化する必要がありますか? クラスだけを文書化したいのですが (ファイルを文書化する必要があるのはなぜですか?)、警告が表示されます...
ありがとうございました
php - PHPスクリプトのクラス構造を自動的に作成できるソフトウェア/スクリプトはありますか?
PHPDocが存在することは知っていphpdocますが、PHPファイルにコメントを入れて解析できるようにしてほしい...
私が欲しいのは何か違うものです: 10 個の PHP クラスがあるとします... 私が欲しいのは、それらのクラスを読み取り、それらのクラス構造の表現を自動的に生成できるスクリプトだけです。つまり、それらのクラス、プロパティ、メソッドなどです。 、その情報をわかりやすい形式で整理します...
これを自動的に行うスクリプトを知っている人はいますか?
php - css ファイルからドキュメントを生成するには?
CSSDoc仕様を参照し、css ファイルからコメント ドキュメントを生成したいと考えています。最初に考えたのは、phpdocumentor ツールを使用することでした。phpdoc -o HTML:frames:default -f main.css -t docsコマンドを実行すると、 「File not parsed,not a php file」というエラー メッセージが表示されました。自動ドキュメンテーション ツールで css ファイルからドキュメンテーションを生成する方法を教えてください。Doxygen、JavaDoc ツールを使用するか、既存のツールを使用して新しいパーサーを作成する必要があります。ありがとう~~~~
php - PHPDoc カスタム セクションとグループ化
Symfony Event Dispatcherを使用して、アプリケーションに基づくイベント ディスパッチ システムを実装中です。管理者は一連のモジュールを有効または有効にすることができ、中央レジストリはプラグインが関心のあるイベントを自動的に登録し、イベントのディスパッチを処理します。
現在、PHPDoc を使用してすべてのドキュメントを生成しており、ドキュメントの完全性と一貫性を保証する厳格な PHP Codesniffer 標準を採用しています。
私がやりたいことは、システムで利用可能なすべてのイベントを 1 か所にリストするドキュメントを自動的に作成することです。利用可能なイベント、これらのイベントで提供されるデータ、およびイベントで送信できる応答を簡単に見つけられるようにすることで、新しいプラグインの開発を容易にしたいと考えています。
PHPDoc を使用してこれを達成する方法はありますか? これまでのところ、私の PluginRegistry クラスを参照して、イベントを通知するメソッドに @uses タグを追加するのが最善の方法です。このようにして、少なくとも関連するメソッドを見つけることができますが、追加のドキュメント (利用可能なイベント、データ、戻りデータ、さらにはメソッド内のイベントの数) を提供しないため、理想にはほど遠いものです。
php - Netbeans のメソッドの前にあるコメント ブロックを更新するには?
いわばプログラミング関連の質問ではないことはわかっていますが、私たちはプログラマーであり、PHP 開発に Netbeans を使用する可能性があるためです。
パラメータセットを変更した後、Netbeans でメソッドの前にあるコメントブロックを更新するにはどうすればよいか疑問に思っています。どういうわけか自動的に更新し、以前に追加したものを保持する必要があります。
メソッドにさらに 10 個のパラメーターを追加し、それを前にコメント セクション (PHPdoc) に表示したいとします。コメント セクションを更新するにはどうすればよいですか?
php - PHPdoc に CakePHP .ctp ファイルを含めるようにします
PHPdocumentorを使用して CakePHP アプリを文書化しています。ご存知かもしれませんが、CakePHP の慣習の後、ビューは .ctp ファイル (例: app/views/addresses/index.ctp) に含まれます。これは基本的に、ファイル拡張子が変更された通常の PHP ファイルです。PHPdocumentor は .php ファイルのみを認識し、設定ファイルに .ctp ファイルを知らせるオプションが見つかりません。このセクションは、私が望むものに最も近いものです:
しかし、 のようなワイルドカードを受け入れないように見えるので*.php、50 個のビュー ファイルのリストをこの構成ファイルに書き込みたくありません (より良い解決策がない限り)。.ctp ファイルを含めるように phpdoc をグローバルに構成する可能性はありますか、それとも phpdoc ソースのどこかにあるややハックなものでこれを変更する必要がありますか?