問題タブ [phpdocumentor2]

phpDocumentor 2 を動作させるのに本当に苦労しています。

文書化する必要がある手続き型のファイルがいくつかあります。私が見つけた唯一の方法は、ページレベルの docblocksを使用することですが、phpDocumentor バージョン 2 では正しく機能しないようです。

stackoverflow に関する関連する質問は、他の人が同じ問題で実行されることを示しています。この質問には、次の 2 つの提案があります。

1. namespace文書化する必要があるファイルに a を追加します
2. phpDoc issue 910以降、テンプレートを使用するかabstract、new-black

残念ながら、どちらも仕事を得ることができません。

1. 名前空間を追加すると、名前空間自体はドキュメントに表示されますが、ドキュメントブロックの内容は表示されません。
2. phpDoc 2 の phar バージョンで別のテンプレート (試してみました) を選択すると、zendエラーが発生します。どうやらこれは既知の問題です。abstractnew-blackPHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar

編集：

私はもう一歩です。phpDocumentor の PEAR バージョンをインストールし、利用可能な各テンプレートを試しました。しかし、生成されたドキュメント内のページ レベルの docblocks という目標にはまだ到達していません。
テンプレートは次の 2 つのカテゴリに分類されます。

• clean、responsive、responsive-twigおよびold-ocean: 生成されたドキュメントでページ レベルの docblock を出力しません。
• abstract、new-blackおよびzend:ファイルごとのドキュメントセクションがあり、予想されるファイル レベルのドキュメントが表示されます。ただし、いくつかのリソース (.js ファイルと画像) が欠落しているため、すべて同じように見え、正しく機能しません (ナビゲーション ペインには展開と折りたたみの動作がありません)。私は彼らの git リポジトリを調べましたが、そこにもファイルがないようです。

この時点で、私は正しい方向を見ているかどうか疑問に思っています.phpDocumentor 2の主要な回帰とバグのために、ファイルレベルのdocblockを示すドキュメントを持つことは不可能です.

本当に間違った方向に進んでいる場合は、私の PHP プロジェクトから貴重なドキュメントを取得する方法を教えてください。私が正しい方向に進んでいる場合は、パズルのどの重要な部分が欠けているかを理解するのを手伝ってください.

最近、HTML 要素を作成するためのクラスを作成しました。既存の HTML 要素と属性ごとにわざわざメソッドを作成する代わりに、魔法のメソッド __get と __call を使用することにしました。したがって、私のコードでは、基本的にこれを行うことができます：

等

しかし、この「魔法」をシンプルに保つことにしたので、次のようにすることもできます。

$signUpForm->insert->magic->trick('rabbit')->accessory('hat')結果は次のようになります。

私の意見では、多くの定型コードを削減し、必要なことを正確に実行するため、これはすべて良いことです。クラスで HTML 標準を強制するのではなく、HTML の使用方法を知っていれば、HTML を容易にするクラスが必要です (正直なところ、これを行うコードは非常に小さいです)。

私の質問は、このクラスが未定義のプロパティまたはメソッドを受け入れることができることを考えると、PHPDoc でこの動作を指定する方法はありますか? 私は運なしで次のことを試しました：

これが単なるPHPStormの問題かどうかはわかりませんが、同様のシナリオはどこにも見つかりませんでした...

また、なぜ私がそのようなことをするのか疑問に思われているかもしれませんが、PHP コードの特定の HTML の側面 (フォームで宣言された ID、フォーム内の要素など) を追跡するためです。これにより、HTML をエンド ユーザーに送信する前に HTML を表示できます。

サンプルファイルを文書化しようとしています:

私はCLIで実行しています：

正常に動作していますが、ここで html 出力を表示しているとき:

クラスとメソッド setupDataConnection はまったく文書化されていません。

これは私が見る画面です：

誰が私が間違っているのか説明できますか?

phpDocumentor を使用してメソッド内からコメント行を取得できるかどうか疑問に思っていました。メソッド ブロックだけでなく、メソッド自体の内部にも多くのコメントを付けています。

コンポーザーの依存関係は、php-xsl がないことを示しています。phpdocumentor/phpdocumentor をインストールしようとしていますが、要件のためにインストールできません。だから今、私は要件をインストールしようとしていますが、これを取得します:

PHP 情報:

それとも、ext-xsl が必要だと言っているのでしょうか? それは何ですか？それとも、私にはPHP xslが必要だと言っているのでしょうか?

これは、マークされた dup 投稿とは異なります。理由については、以下の私のコメントを参照してください。

laravel 5で phpdocumentorを使用する方法CLI 以外でドキュメントを生成する簡単な方法はありますか?

phpDocumentor でドキュメントを生成する場合、@param の場合、@return 値はプロジェクト内の次のようなクラスです。

phpdoc は My\Awesome\Class をそのクラスのドキュメントに自動的にリンクします。ベンダークラスのドキュメントにリンクさせる方法があるかどうかを調べようとしています。つまり、make:

http://www.doctrine-project.org/api/common/2.5/class-Doctrine.Common.Collections.ArrayCollection.htmlへのリンク。私が見つけた最も近い解決策は、phpdoc にすべてのベンダー ライブラリのドキュメントも生成させることですが、これは理想的とは言えません。

http://www.phpdoc.org/docs/latest/guides/types.html#primitivesから

PHPDoc は type のみを認識するようですfloat。

PHP が C/C++ で書かれているのを見ると、なぜ PHP がdouble型として提供されないのか疑問に思います。

PHPDoc ブロックに、メソッド パラメータの既存のドキュメントへのリンクを提供したいと考えました。そこで、@linkタグを使用して、その後に URL を配置しました。問題は、URL が長すぎて、私の IDE では見栄えがよくないことです。このような状況を管理するために何を提案しますか? DocBlock を快適に見せるか、何らかの方法で URL を短くしすぎることを意味しますか? URL は内部 wiki につながり、ロシア語の記号が含まれているため、さらに長くなります。PHPStorm と NetBeans をプライマリ IDE として使用します。