2010-10-11 76 views
4

我想了解phpDocumentor。我通常會爲每個文件添加一個類。我是否被迫記錄文件和類?我想記錄只是類(爲什麼我應該記錄文件?),但我收到警告...phpDocumentor:僅文檔類

WARNING in comment.class.php on line 8: DocBlock would be page-level, but precedes class "Comment", use another DocBlock to document the file 

我讀過http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html

謝謝

回答

1

您不必記錄文件,它只是一個警告。如果您沒有放置文件級文檔,那麼即使「class」列表中有一些文件,也沒有關於phpdoc「files」列表的信息。

+0

有沒有辦法** **這些警告? – Nathaniel 2012-05-30 22:21:54

+0

@NatIsGleek你爲什麼需要壓制它們?當您運行php documentor腳本時,您可以將錯誤輸出路由到'/ dev/null' – 2012-05-31 02:48:04

+0

雖然文件仍然顯示在列表中.. – 2012-06-07 17:27:21