2017-08-06 9 views
0

私のcodeigniterプロジェクトでPHP Documentorを使いたいです。 私は梨を経由してphpdocsをインストールし、私は自分のアプリケーションディレクトリで次を実行して、それを使用しようとしました:phpdoc codeigniterフォルダクラスが空です

phpdoc -d controllers 

すべてのメソッドはdocblocksのようにコメントしています。

私の結果はindex.htmlファイルのフォルダですが、私が開いたときに私は自分のクラスを入力することはできません。それは私にエラーを返します:

file not found

さらに、私のclasessディレクトリは空です。 curosityの私は私のクリーンなPHPファイルにphpdocを使用してみて、それは私に通常のドキュメントを示しています。

誰かがcodeigniterプロジェクトでphpdocを使う方法を教えていただけますか? 他にも同様の結果をもたらすソフトウェアがありますか?

答えて

0

クラスがフレームワークによって自動的に生成される場合は、docブロックに@internalまたは@ignoreが含まれているかどうかを確認してください。前者の場合は、--parseprivate argを使用します。後者の場合は、手動でタグを削除する必要があります。

ドキュメントが生成されない理由は他にありません。

+0

私のプロジェクトの無視タグまたは内部タグは表示されません:/ –

+0

私の次の考えは次のようになります:a)クラスが 'controllers'ディレクトリ内にない*なら、文書化されません。 b) 'コントローラ'ディレクトリにあるものがクラス自身ではない場合、phpDocumentorがファイル自体を除いて実際に文書化することは何もありません。 したがって、a)の場合、クラス定義ファイルが他のディレクトリにある場合、そのディレクトリを '-d' argに追加する必要があります。 b)の場合、 'controllers'のファイルがクラスではなく手続き型コードだけであれば、実際に文書化するためにphpDocumentorで利用可能な「文書化可能なコード要素」はありません。 – ashnazg

関連する問題