2011-06-13 57 views
1

我想寫在每個PHP文件中的評論,然後評論將生成Doxygen,有誰知道如何寫評論頭PHP文件?如何使用Doxygen編寫評論標題PHP文件?

+0

你能詳細說明一下你的問題嗎? – cweiske 2011-06-13 06:26:44

+0

我想知道如何使用Doxygen編寫文檔程序,我從文件頭開始,但是我不知道如何正確編寫頭文件,謝謝! – 2011-06-13 06:49:00

回答

4

使用你最喜歡的$ searchengine來尋找「php doxygen教程」。我發現http://www.stack.nl/~dimitri/doxygen/docblocks.html#specialblock會有所幫助。

對於PHP,您可能還需要查看phpDocumentordocblox

一般來說,在一個PHP文件中的文檔塊標題是這樣的:

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

我建議您閱讀phpDoc quickstart tutorial。請注意,doxygen支持phpdoc語法。

+0

感謝cweiske,它幫助我很多 – 2011-06-14 03:14:12

+0

實際上,我需要一個帶Doxygen的文檔,@author,@file,@section已經記錄,但文件夾中的文件沒有記錄,我陷入了這個問題。 – 2011-06-15 11:40:03

+0

具有諷刺意味的是,該頁面是上述查詢的第一個結果:) – 2013-06-05 15:07:49