時々、私はいくつかの行の前に '@'が付いたPHPコメントを見ます。 @Author
のように。これには特別な理由はありますか?私はこれについて何かを見つけることができないようです。私は '@'を探す高度に使われたパーサがあると仮定しています。コメント内の「@」はなぜですか?
2
A
答えて
10
これはphpDocumentor表記、ソースコードを解析し、プログラム(およびそれら@コメント)自動生成ドキュメントへの最も可能性が高いです。多くのIDEは、これらのコメントに基づいてインテリジェントなルックアップとオートコンプリート機能も提供します。
例:
/**
* Echoes "example".
* @author Pekka
* @version 1.5
* @return void
*/
function example()
{
echo "example";
}
2
これはコメントからドキュメントを作成するために、自動ドキュメンテーションジェネレータによって使用されています。いくつかのツールやフォーマットはそこにあります。
- phpDocumentorの
- Doxygenの
- HeaderDoc
は数を一覧表示します。
1
コメントのソースコードを解析し、(など、HTML、Windowsのの.chmファイル、など)さまざまな形式で複雑なヘルプファイルを作成したパッケージがたくさんあります。 Javaにはjavadocがありますが、DoxygenとDoc-O-Maticもあります。
関連する問題
- 1. CSSに//コメントがないのはなぜですか?
- 2. なぜouterHTMLは<!-- -->のコメントを返すのですか?
- 3. コメントに誤りがあるのはなぜですか?
- 4. この文字列をコメント化できないのはなぜですか?
- 5. なぜ私のPHPコードがコメントに変わるのですか?
- 6. 入れ子のコメントが大きくなるのはなぜですか?
- 7. なぜコメントのパラメータ名ではなく、それが
- 8. RCovはビューを除外しコメントを含むのはなぜですか?
- 9. PHP変数の型をコメントに宣言するのはなぜですか?
- 10. なぜfacebookのコメントが狭いのかを調べるには?
- 11. なぜこのコメントはRuby on Railsでコンパイルエラーを生成しますか?
- 12. LEF内のDEFUN - なぜですか?
- 13. なぜWebpackは各行の前に奇妙なコメントを出力しますか?
- 14. .rgsファイル内のコメントの構文は何ですか
- 15. EAXの内容が異なるのはなぜですか?
- 16. NetFxヘルパーはなぜ内部的なのですか?
- 17. マクロ内のDoxygenコメント
- 18. Doxygen - オーバーライドされたメソッド - コメントは継承されません、なぜですか?
- 19. [---]は.gitconfigのコメントですか?
- 20. なぜクラングは「||」内の「&&」を警告するのですか?
- 21. javadocツールはメソッド内のコメントを認識しますか?私はそのような私のビジネスロジック内の多くのコメントを書かれている
- 22. なぜ=と<は内部で同じではないのですか?
- 23. 私のウィジェットはワイヤクラウド内で動作しないのはなぜですか?
- 24. なぜwhileループ内で評価できないのですか?
- 25. 1Mレコードの挿入は、トランザクション内ではなく、トランザクション内でより遅いのはなぜですか?
- 26. なぜソフトキーボードがダイアログフラグメント内のウェブビュー内で動作しないのですか?
- 27. 動画のプライバシーステータスを更新するとコメントが無効になるのはなぜですか?
- 28. require.jsがheadタグ内にあるのはなぜですか
- 29. なぜループの内部は悪い考えですか?
- 30. notifyメソッドがsynchronizedブロック内にあるのはなぜですか?
グーグル:「PHP解析ツール」私はちょうど先週のphpDocumentor関連の答えを提供するとき、私は忘れてしまった可能性がどのように –