3

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

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

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

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output
4

4 に答える 4

3

私は自分の質問に答えるとは思っていませんでしたが、2日間の心の曲がりくねった痛みと週末の実験の後、これが問題のようです:

チュートリアルと私の例は機能するはずですが、phpdoc がスイッチ値を解釈する方法に小さな欠陥があるようです。これが私が使ってきたものです：

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

ただし、次を使用する場合：

    phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/
-t /path/to/output

チュートリアルと拡張ドキュメントを正しくフォーマットします。私がしたことは、ディレクトリ パスを囲む二重引用符を削除することだけでした。一重引用符はまったく機能しません - スペースがない場合、phpdoc 自体がディレクトリを二重引用符で囲むため、これは phpdoc のバグのようであり、同じ動作が Web ベースのインターフェースで発生したため、内部問題。私の最初の試みはうまくいくはずでしたが、そうではありませんでした。開発者に連絡して、彼らの注意を引くつもりです。

問題が解決しました。

于 2009-08-10T09:36:18.443 に答える
1

これを読んだことがありますか？

次のパス スキームが提案されています: tutorials/package/package.pkgここで、package はパッケージの名前です。

于 2009-08-06T23:36:40.083 に答える
0

構成に .ini を使用して同じ問題が発生していましたが、コンマとディレクトリの間にスペースを入れると、ディレクトリが -d パラメータに「リンク」されないという問題がありました。

動作していません:

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials

働く：

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials

これが他の誰かの問題を解決することを願っています!

于 2011-06-16T08:01:29.040 に答える
0

はい、二重引用符を使用すると、おそらく phpDocumentor の内部実行時引数の解析が中断され、追加のディレクトリ値として-d /path/to/code/classes含めずに、引数と値のペアが 1 つになりました。/path/to/code/docs/tutorials

通常、チュートリアルが作成されないという問題が他に 2 つあります。1 つ目は、チュートリアル ディレクトリが phpDocumentor が期待するものではないことです。2 つ目は、実際の PHP コード ファイルが実行に含まれていないことです。この 2 つのシナリオに特化してマニュアルに言葉遣いを追加したことを覚えています。

于 2009-11-22T15:08:54.493 に答える