我一直在代码中添加docblocks,并解决了phpDocumentor 脚本生成并放入errors.html 文件中的大部分构建错误和警告。
然而,我当前的文档构建中还有最后一类警告 - 对于我在应用程序中记录的从外部库(在本例中为 Zend)继承的每个类,我都会收到警告。
有没有办法停止警告,例如Warning - Class AMH_Controller_Action parent Zend_Controller_Action not found
从发生?我如何通知 phpDoc 父级来自外部库,并可能提供 Zend 文档的参考链接?
phpDocumentor 本身没有本地选项来处理此用例。我过去所做的是创建一个虚拟文件,其中包含所有“未找到”类的空类声明,将这些类标记为“@package DoNotDocument”,并使用运行时 --packageoutput 参数 [1]without在要包含在输出文档中的包列表中列出“DoNotDocument”。诚然,这是一个 hack,但效果是:
a)避免“未找到”警告(因为类现在“存在”),
同时 b) 不为虚拟类创建任何文档。
/**
* @package DoNotDocument
*/
class Zend_Controller_Action {}
phpdoc -d ./src -t ./docs -po MyPackage1,MyPackage2
现在,如果您的类确实扩展了 ZF 类,那么关于您的文档需要考虑一些事情。如果不让 phpDocumentor 解析这些 ZF 源,您的类的 API 文档将不会显示从这些 ZF 父级继承的方法等。如果这是我的代码库,我将允许 phpDocumentor 解析 ZF 文件,但会避免将 ZF 类记录为not在运行时 --packageoutput 参数中列出它们固有的 @package 值(例如“Zend_Controller”)。
[1] -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.packageoutput http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.packageoutput
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)