2011-06-13 17 views
1

私は各PHPファイルにコメントを書き込もうとしていますが、コメントはDoxygenによって生成されます。コメントヘッダPHPファイルを書く方法を知っていますか?Doxygenを使用してコメントヘッダPHPファイルを作成するには?

+0

質問をもう少し詳しく説明できますか? – cweiske

+0

Doxygenを使ってドキュメンテーションプログラムを書く方法を知りたいのですが、ファイルのヘッダから始めますが、ヘッダファイルを正しく書いてもらえません!ありがとう! –

答えて

4

お気に入りの$ searchengineを使って "php doxygen tutorial"を探しましょう。私はhttp://www.stack.nl/~dimitri/doxygen/docblocks.html#specialblockが役に立ちました。

PHPの場合は、phpDocumentorまたはdocbloxを調べることもできます。

は一般的に、PHPファイル内のDocblockヘッダーは次のようになります。

<?php 
/** 
* This is the file description 
* 
* @author Christian Weiske <[email protected]> 
*/ 
... 

私はphpDoc quickstart tutorialを読んで示唆しています。 doxygenはphpdocの構文をサポートしています。

+0

ありがとうcweiske、その助けて私のたくさん –

+0

実際には、私はDoxygen、@author、@file、@sectionで文書化が必要ですが、文書化されていないフォルダ内のファイルは、私はこれで立ち往生しています。 –

+0

皮肉なことに、このページは上のクエリの最初の結果です:) –

関連する問題