位置: 编程技术 - 正文
推荐整理分享完美解决phpdoc导出文档中@package的warning及Error的错误(php dao),希望有所帮助,仅作参考,欢迎阅读内容。
文章相关热门搜索词:php导包,php导入php文件,php导包,php dao,phpdocumentor,php导入文件,php导入文件,php dao,内容如对您有帮助,希望把文章链接给更多的朋友!
今天在编写PHPDoc的导出文档的时候发现一个很郁闷的错误,虽然这个warning不是什么重要错误,但是看着总是很不爽的。于是就去网上找了很多相关的资料,可是郁闷的是不知道是我用的PHPDoc版本太新(1.4的版本),还是说很多人都没遇到这个问题,反正就是没有相关的这个资料找到,只是找到了一些从PHPDocumentor官方网倒出来的关于@package的使用注意事项,然后就只能一条一条检查,看了一个版本又一个版本,总算是被我解决了。
而且发现该方案可以解决@package之类相关的错误提示:
出现的问题:
1、no @package tag was used in a DocBlock for XXXXXXXXXXX
2、XXXXXX has no page-level DocBlock, use @package in the first DocBlock to create one
3、ERROR: XXXX can not have @package tag。。。。(具体的提示我忘记了,大题的意思是这里的文档不能使用@package标签)
出现上诉问题的主要原因是:页面级的文档块注释解析错误
页面级文档注释:
必须是文件中的第一个文档块注释,并且有@package标签
该文档快注释之后如果是紧接着一段PHP代码或是class类申明,必须用文档块注释隔开(也就是说页面级文档块注释之后不能紧接着代码片段)
比如情况:
以上的情况就会出现上述2的错误信息 解决该案例的方案是给class重新声明一个文档块注释 *********************************************** 案例二: 会出现如上问题中的1/2的情况。 解决方案也是如案例一的解决方案一样 *********************************************** 案例三: 就会出现如上所说的情况3Error。 解决方案也是如出一则:如果所写的文档块正确,就不会出现@package相关的错误了。
注:
1、在注释中需要注意,任何不是/** */类型的注释都不会被PHPDoc所解析。而且/** */中的多行注释前面不是以*开头的注释行也不会被解析。
2、如果声明了标签却没有给出相关的标签必选项就会发出一个Error信息,比如@var 后面没有变量,@return后面没有返回类型,都将会出现Error错误。解决方式就是补充完整,或是如果没有的话就移除。
另外,提供一个命令行方式下的命令文件执行,自动执行Doc文档生成:
注:该命令需要安装命令行下的PHPDocumentor包,安装方式用pear安装。
谨此!
以上这篇完美解决phpdoc导出文档中@package的warning及Error的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持积木网。
XHProf报告字段含义的解析 FunctionName:方法名称。Calls:方法被调用的次数。Calls%:方法调用次数在同级方法总数调用次数中所占的百分比。Incl.WallTime(microsec):方法执行花费的时
php关闭warning问题的解决方法 error_reporting设定错误讯息回报的等级我记得应该是E_ALL。php.ini文件中有许多配置设置。您应当已经设置好自己的php.ini文件并把它放在合适的目录中,
浅析php静态方法与非静态方法的用法区别 在php编程中,static关键字声明一个属性或方法是和类相关的,而不是和类的某个特定的实例相关,因此,这类属性或方法也称为类属性或类方法如果访
标签: php dao
本文链接地址:https://www.jiuchutong.com/biancheng/294901.html 转载请保留说明!上一篇:ECSHOP完美解决Deprecated: preg_replace()报错的问题(ecshop有哪些bug)
下一篇:XHProf报告字段含义的解析
友情链接: 武汉网站建设