ホームページ >バックエンド開発 >PHPチュートリアル >phpdoc エクスポート ドキュメント、_PHP チュートリアルの @package の警告エラーとエラー エラーを完全に解決します。
phpdoc エクスポート ドキュメント、_PHP チュートリアルの @package の警告エラーとエラー エラーを完全に解決します。
- WBOYオリジナル
- 2016-07-12 08:52:10861ブラウズ
phpdoc エクスポート ドキュメントの @package の警告とエラーを完全に解決します
今日、PHPDoc エクスポート ドキュメントを作成するときに非常に憂鬱なエラーを見つけました。この警告は重要なエラーではありませんが、いつも迷惑に思えます。 。そこで、インターネットで関連情報をたくさん探しましたが、イライラしたのは、私が使用していた PHPDoc のバージョン (バージョン 1.4) が新しすぎるのか、それとも多くの人がこの問題に遭遇していないのかが分からなかったことです。とにかく、関連する情報は見つからず、PHPDocumentor の公式 Web サイトからダンプされた @package の使用に関するいくつかのメモを見つけて、それを 1 つずつ確認し、次から次へと読むしかありませんでした。それを解決しました。
そして、このソリューションが @package 関連のエラー プロンプトを解決できることがわかりました:
問題:
1. XXXXXXXXXXX の DocBlock で @package タグが使用されていません
2. XXXXXX にはページレベルの DocBlock がありません。最初の DocBlock で @package を使用して DocBlock を作成します
3. エラー: XXXX には @package タグを含めることはできません。 。 。 。 (具体的なヒントを忘れました。大きな質問は、ここのドキュメントでは @package タグを使用できないことを意味します)
異議申し立ての問題の主な理由は次のとおりです: ページレベルのドキュメントブロックのコメント解析エラー
ページレベルのドキュメントのコメント:
ファイル内の最初の docblock コメントであり、@package タグが必要です
ドキュメント ブロック コメントの後に PHP コードまたはクラス宣言が続く場合は、ドキュメント ブロック コメントで区切る必要があります (つまり、ページレベルのドキュメント ブロック コメントの後にコードフラグメントを続けることはできません)
例:
書かれたドキュメントブロックが正しい場合、@package 関連のエラーは発生しません。
注:
1. /** */ ではないコメントは PHPDoc によって解析されないことに注意してください。また、/** */ 内の * で始まらない複数行のコメントは解析されません。
2. ラベルが宣言されているが、関連するラベルに必要なオプションが指定されていない場合、たとえば、@var の後に変数がなく、@return の後に戻り値の型がない場合、エラー メッセージが発行されます。現れる。解決策は、それを完了するか、存在しない場合は削除することです。
さらに、Doc ドキュメントを自動的に生成するために、コマンド ライン モードでのコマンド ファイルの実行が提供されています。
リーリー注: このコマンドは、コマンドラインで PHPDocumentor パッケージをインストールする必要があります。インストール方法は、pear インストールを使用することです。
敬具！
上記の記事は、phpdoc エクスポート ドキュメントの @package の警告エラーとエラー エラーを完全に解決します。これは、編集者が共有したすべての内容です。また、皆さんにも Bangkejia をサポートしていただければ幸いです。
。