7

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

4

0 に答える 0