完美解决phpdoc导出文档中@package的warning及Error的错误
今天在编写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类申明,必须用文档块注释隔开(也就是说页面级文档块注释之后不能紧接着代码片段)
比如情况:
案例一:复制代码 代码如下:/** * 这个是一个页面级文档块注释 *@package haha * */ class test { }以上的情况就会出现上述2的错误信息 解决该案例的方案是给class重新声明一个文档块注释复制代码 代码如下:/** * 这个是一个页面级文档块注释 *@package haha * */ /** * 我是test类 */ class test { }*********************************************** 案例二:复制代码 代码如下:/** * 这个是一个页面级文档块注释 */ /** * 这个是一个页面级文档块注释 *@package haha * */ class test { }会出现如上问题中的1/2的情况。 解决方案也是如案例一的解决方案一样 *********************************************** 案例三:复制代码 代码如下:/** * 这个是一个页面级文档块注释 *@package haha * */ define('yyyy', 'hahha');就会出现如上所说的情况3Error。 解决方案也是如出一则:复制代码 代码如下:/** * 这个是一个页面级文档块注释 *@package haha */ /** * 我是常量 */ define('yyyy', 'hahha');如果所写的文档块正确,就不会出现@package相关的错误了。
注:
1、在注释中需要注意,任何不是/** */类型的注释都不会被PHPDoc所解析。而且/** */中的多行注释前面不是以*开头的注释行也不会被解析。
2、如果声明了标签却没有给出相关的标签必选项就会发出一个Error信息,比如@var 后面没有变量,@return后面没有返回类型,都将会出现Error错误。解决方式就是补充完整,或是如果没有的话就移除。
另外,提供一个命令行方式下的命令文件执行,自动执行Doc文档生成:
@Rem: 命令行格式自动导出PHPDoc文档 @Rem: author: 肖肖 x_824@sina.com @echo off @echo ******************************************************************************* @echo 自动导出文档使用说明: @echo 需要安装命令行的PHPDOCumentor,安装方式是用pear安装pear install PhpDocumentor即可 @echo 1、option:设置导出文档的格式,命令行格式支持四种格式:默认为第一种格式 @echo ###1】、HTML:frames:default @echo ###2】、HTML:Smarty:default @echo ###3】、CHM:default:default @echo ###4】、PDF:default:default @echo 2、dir:需要执行导出文档的目录、 @echo 3、outputDir: 导出的文档存放目录 @echo 4、title:导出的文档的标题 @echo ******************************************************************************* @set option=HTML:frames:default @set dir=D:\PHPAPP\test @set outputDir=D:\PHPAPP\doc @set title=PHPWindDoc @phpdoc -d %dir% -o %option% -ti %title% -t %outputDir% @echo 欢迎使用!导出成功 @pause注:该命令需要安装命令行下的PHPDocumentor包,安装方式用pear安装。
谨此!
以上这篇完美解决phpdoc导出文档中@package的warning及Error的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。
相关文章
MySQL ERROR 1045 (28000) 错误的解决办法
这篇文章主要介绍了MySQL ERROR 1045 (28000) 错误的解决办法,很实用的解决方法,感兴趣的小伙伴们可以参考一下...2016-06-24- 这篇文章主要为大家详细介绍了mysql输入中文出现ERROR 1366的解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2017-05-09
Windows平台的 PHP 报错 Fatal error: Class COM not found in 的解决方法
这篇文章主要介绍了Windows平台的 PHP 报错 Fatal error: Class COM not found in 的解决方法,需要的朋友可以参考下...2016-01-27Global.asax的Application_Error实现错误记录/错误日志的代码
本文为大家介绍下利用Global.asax的Application_Error实现错误记录,具体如下,有此需求的朋友可以参考下,希望对大家有所帮助...2021-09-22MySQL无法读表错误的解决方法(MySQL 1018 error)
这篇文章主要为大家详细介绍了MySQL无法读表错误的解决方法,MySQL 1018 error如何解决?具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2017-01-22- 自学党们在自学php的时候,经常会发生一些小错误,这篇文章主要介绍了PHP常见的6个错误提示及解决方法,感兴趣的小伙伴们可以参考一下...2016-07-25
解决MySQL5.1安装时出现Cannot create windows service for mysql.error:0
这篇文章主要介绍了解决MySQL5.1安装时出现Cannot create windows service for mysql.error:0问题的方法...2016-06-24完美解决phpdoc导出文档中@package的warning及Error的错误
下面小编就为大家带来一篇完美解决phpdoc导出文档中@package的warning及Error的错误。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-05-20IIS提示Server Application Error的解决方法集锦第1/2页
The server has encountered an error while loading an application during the processing of your request. Please refer to the event log for more detail information. Please contact the server administrator for assistance....2016-01-27mysql出现ERROR 1819 (HY000)的解决方法
这篇文章主要为大家详细介绍了mysql出现ERROR 1819 (HY000)的解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2016-10-25MySQL ERROR 1045 (28000): Access denied for user 'root'@'localhost' (using password: NO) 的原因分解决办
这篇文章主要介绍了MySQL ERROR 1045 (28000): Access denied for user 'root'@'localhost' (using password: NO) 的原因分解决办法的相关资料,需要的朋友可以参考下...2016-05-14ubuntu系统中Mysql ERROR 1045 (28000): Access denied for user root@ localhost问题的解决方法
这篇文章主要介绍了ubuntu系统安装mysql登陆提示 解决Mysql ERROR 1045 (28000): Access denied for user root@ localhost问题,需要的朋友可以参考下...2017-05-25jQuery Uploadify 上传插件出现Http Error 302 错误的解决办法
本文给大家介绍jQuery Uploadify 上传插件出现Http Error 302 错误的解决办法,涉及到uploadify上传错误302相关问题,对本文感兴趣的朋友一起看看吧...2015-12-14解决MySQL安装重装时出现could not start the service mysql error:0问题的方法
这篇文章主要为大家详细介绍了解决MySQL安装重装时出现could not start the service mysql error:0问题的方法,感兴趣的小伙伴们可以参考一下...2016-06-24nginx提示:500 Internal Server Error错误的解决方法
本文章来给大家总结了大量关于导致nginx中提示500 Internal Server Error错误的原因总结与解决方法分析有需要了解的朋友可参考参考...2016-01-27mysql中错误:1093-You can’t specify target table for update in FROM clause的解决方法
最近在工作中遇到了一个mysql错误提示1093:You can’t specify target table for update in FROM clause,后来通过查找相关的资料解决了这个问题,现在将解决的方法分享给大家,有需要的朋友们可以参考借鉴,下面来一起看看吧。...2017-01-15- 下面小编就为大家带来一篇php关闭warning问题的解决方法。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-05-20
C#预处理指令之#line,#pragma warning 详细解析
#line 指令可能由生成过程中的自动中间步骤使用。例如,如果行从原始的源代码文件中移除,但是您仍希望编译器基于文件中的原始行号生成输出,则可以移除行,然后用 #line 模拟原始行号...2020-06-25HTTP 错误 500.19- Internal Server Error 错误解决方法
HTTP 错误 500.19- Internal Server Error 错误解决方法,碰到这个问题的原因有很多,大家可以参考下,看属于哪种情况。...2016-01-27解决mysql安装时出现error Nr.1045问题的方法
这篇文章主要为大家详细介绍了解决mysql安装时出现error Nr.1045问题的方法,感兴趣的小伙伴们可以参考一下...2016-06-24