問題タブ [phpdocumentor2]

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.

0 投票する
1 に答える
409 参照

phpdoc - cssおよびjavascriptへのphpDocumentor相対パス

phpDocumentor 2 を使用するのは初めてですが、ドキュメントのルート フォルダーにあるすべてのファイルは正常に見えます。

残念ながら、サブディレクトリ (クラス、名前空間、およびパッケージ) にあるものは、「../css/template.css」ではなく「css/template.css」を参照しているため、正しく見えず、正しく機能しません。(JSと同じ問題)

ある種の構成の問題がありませんか? phpDoc サイトのデモには、親ディレクトリへの参照が含まれているようです。

前もって感謝します!

0 投票する
2 に答える
2160 参照

php - サブクラスで継承された関数/変数を phpdoc で文書化する

phpdocを持ついくつかの変数を持つ親クラスがあるとしましょう:

今、この変数がオーバーライドされた子クラスを作成しています。

私の質問は、変数の説明をコピーして貼り付ける必要がないように、Child クラスの $variable に対してどの phpdoc を記述すればよいですか? 同じ質問がメソッドにも当てはまります。助けていただければ幸いです。

更新: phpdoc の作成後にエラーが表示された後、この質問をしました。この要約を追加すると、エラーは消えますが、子クラスに何を書いても、phpdocには親クラスからの説明が表示されます。私は何を間違っていますか?

0 投票する
1 に答える
481 参照

phpdoc - phpdocumentator2、phpdoc、インライン リンクを解析しない

メソッドへのインラインタグを取得しようとすると問題が発生しますphpDocumentor version 2.0.0a12. 以下のサンプル コードを使用すると、{@link パラメータ} で何を試しても (例: /global/foo::bar()、foo::bar、foo::bar() など)、テキストが毎回出力されます。 html アンカー タグとして解析される代わりに。

他の誰かがこれを見ていますか?

たぶん、設定パラメータがありませんか?上記を使用する構成は次のとおりです。

これは、 PHPDoc インライン {@link} (および Netbeans)の複製と見なすことができますが、コマンドラインから phpdoc を呼び出しているため (および IDE を使用していないため)、そうは思いません。どんな助けも真剣に感謝します;)

0 投票する
1 に答える
1121 参照

php - phpDocumentor は親クラスのドキュメントをオーバーライドしません

したがって、基本的には次の設定があります。

これを phpDocumentor2 でドキュメント化しようとすると、クラス B のメソッド foo() に「これはドキュメントです」と表示されますが、「このドキュメントはクラス A よりも具体的です」と表示されます。phpDocumenter 1 では、すべてが期待どおりに見えます。それで、ここで何が起こっているのですか?これは phpDocumentor2 の新しいデフォルトの動作ですか? もしそうなら、それを変更する方法はありますか?それとも、これは単なるバグですか?

注: 調査中に {@inheritDoc} に頻繁に出くわしましたが、まったく逆の動作をしたいと考えています。

0 投票する
1 に答える
2350 参照

phpdocumentor2 - PHPDocumentor2 で PDF を生成しますか?

phpdoc -d lib/model -t /var/www/html/docs/ --テンプレートレスポンシブ

html ドキュメントを正常に生成します。

PHPDocumentor2 にアップグレードしましたが、PDF に出力するためのコマンドが見つかりません。1.x の古い方法は、新しいバージョンでは機能しません。

誰かがこれを行う方法を教えてくれるか、ドキュメントを教えてくれますか?

前もって感謝します。

0 投票する
3 に答える
6006 参照

php - PEAR を使用して phpDocumentor をインストールする

http://www.phpdoc.org/のホームページ、http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html、およびhttps://github.com /phpDocumentor/phpDocumentor2、phpDocumentor をインストールする手順は次のとおりです。

私がそうするとき、私はそれが非推奨であることがわかります:

http://www.phpdoc.org/docs/latest/for-users/installation/using-pear.html#requirementsによると、手順は次のとおりです。

PEAR を使用して phpDocumentor をインストールするための推奨される方法はどれですか?

0 投票する
1 に答える
726 参照

php - PHP ドキュメントから Word ドキュメントを作成する

コードを文書化するには、phpDoc 構文を使用するのがベスト プラクティスであると考えました。これは、いくつかのパーサーがあり、一部の IDE はそれから IntelliSense を作成するためです。

ここで、ドキュメント (API) を Word ファイルに入れる必要がありますが、どのパーサーが .doc などを出力できるかわかりません。

.rtf と phpDocumentor2 を出力する DoxyGen を試してみましたが、.html と .xml にしかエクスポートできません (?)。

phpDoc から .doc(x) ファイルを生成する方法はありますか? または、Word にインポートできるドキュメントを取得する簡単な方法はありますか? 私のドキュメントは非常に長いので、phpDoc 構文を変更する必要がなければありがたいです。


編集: PHP 5.3 の機能をサポートし、DoxyGen よりも高速であるため、推奨されるパーサーは phpDocumentor2 です。


編集: コンテンツを .rtf ファイルから .docx ファイルにコピーしようとしましたが、[コピー先のスタイルを使用] を選択すると、両方の Word インスタンスが停止し、応答しません。