php文档: document only classes

标签 php documentation document phpdoc

我正在尝试了解 phpDocumentor。我通常为每个文件放一个类。我是否被迫记录文件和类(class)?我只想记录类(我为什么要记录文件?)但我收到警告...

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 .

谢谢

最佳答案

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

关于php文档: document only classes,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/3906846/

相关文章:

php - MySQL 查询返回后页面不会加载?

php - php : 1000 fields per POST. 内的新限制有人知道,如果数字会受到影响吗?

javascript - 将 javascript 变量传递到下一个 php 页面

javascript - 是否有任何软件包可以让您记录 gruntfile,类似于 Node 的 apiDocs?

php - 转换 PDF 并添加首页、页脚和水印

javascript - $(document).on 的 jquery 问题会删除变量

php - 只分页一次

python - 文档主页,如 Python 文档或 Sphinx 文档?

python - 文档字符串 - 一行与多行

search - 使用Elasticsearch在子文档中搜索术语