php - phpDocumentor：仅记录类

Question

我正在尝试了解 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。

谢谢

Answer 1

您不必记录该文件，这只是一个警告。如果您不放置文件级文档，那么 phpdoc“文件”列表中将没有信息，即使“类”列表中会有一些信息。