完美解决phpdoc导出文档中@package的warning及Error的错误


Posted in PHP onMay 17, 2016

今天在编写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的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

PHP 相关文章推荐
PHP 数组实例说明
Aug 18 PHP
优化PHP程序的方法小结
Feb 23 PHP
解析php根据ip查询所在地区(非常有用,赶集网就用到)
Jul 01 PHP
php实现与erlang的二进制通讯实例解析
Jul 23 PHP
Win2003+apache+PHP+SqlServer2008 配置生产环境
Jul 29 PHP
php 在线导入mysql大数据程序
Jun 11 PHP
PHP5.5迭代生成器用法实例详解
Mar 16 PHP
win10环境PHP 7 安装配置【教程】
May 09 PHP
php实现有序数组打印或排序的方法【附Python、C及Go语言实现代码】
Nov 10 PHP
PHP中关键字interface和implements详解
Jun 14 PHP
基于php+MySql实现学生信息管理系统实例
Aug 04 PHP
PHP常用header头定义代码示例汇总
Aug 29 PHP
ECSHOP完美解决Deprecated: preg_replace()报错的问题
May 17 #PHP
简单理解PHP的面向对象编程方式
May 17 #PHP
WordPress中的shortcode短代码功能使用详解
May 17 #PHP
CodeIgniter生成静态页的方法
May 17 #PHP
CodeIgniter连贯操作的底层原理分析
May 17 #PHP
CI框架常用方法小结
May 17 #PHP
CodeIgniter记录错误日志的方法全面总结
May 17 #PHP
You might like
PHP创建PowerPoint2007文档的方法
2015/12/10 PHP
ThinkPHP 3.2.3实现页面静态化功能的方法详解
2017/08/03 PHP
有关PHP 中 config.m4 的探索
2020/08/26 PHP
JQuery的Alert消息框插件使用介绍
2010/10/09 Javascript
javascript Array.prototype.slice使用说明
2010/10/11 Javascript
jQuery学习笔记之jQuery的动画
2010/12/22 Javascript
jquery库或JS文件在eclipse下报错问题解决方法
2014/04/17 Javascript
BootStrap中Tab页签切换实例代码
2016/05/30 Javascript
多种方式实现js图片预览
2016/12/12 Javascript
JS实现焦点图轮播效果的方法详解
2016/12/19 Javascript
JS前端加密算法示例
2016/12/22 Javascript
JS获得一个对象的所有属性和方法实例
2017/02/21 Javascript
基于AGS JS开发自定义贴图图层
2017/03/31 Javascript
深入理解vue $refs的基本用法
2017/07/13 Javascript
JavaScript实现AOP详解(面向切面编程,装饰者模式)
2017/12/19 Javascript
通过vue提供的keep-alive减少对服务器的请求次数
2018/04/01 Javascript
微信小程序功能之全屏滚动效果的实现代码
2018/11/22 Javascript
vuex 中插件的编写案例解析
2019/06/10 Javascript
在Angular项目使用socket.io实现通信的方法
2021/01/05 Javascript
[01:21]DOTA2周边文化主题展 神秘商店火热开售
2017/07/30 DOTA
进一步理解Python中的函数编程
2015/04/13 Python
Python导入oracle数据的方法
2015/07/10 Python
python文件与目录操作实例详解
2016/02/22 Python
python下setuptools的安装详解及No module named setuptools的解决方法
2017/07/06 Python
Pandas 数据处理,数据清洗详解
2018/07/10 Python
python实现一个猜拳游戏
2020/04/05 Python
如何利用python进行时间序列分析
2020/08/04 Python
Flask处理Web表单的实现方法
2021/01/31 Python
HTML文本属性&颜色控制属性的实现
2019/12/17 HTML / CSS
美国专业汽车音响和移动电子产品零售商:Car Toys
2019/05/13 全球购物
个人找工作的自我评价
2013/10/17 职场文书
财会自我鉴定范文
2013/12/27 职场文书
土建资料员岗位职责
2014/01/04 职场文书
新闻学专业个人求职信写作
2014/02/04 职场文书
2015年公务员转正工作总结
2015/04/24 职场文书
Java使用JMeter进行高并发测试
2021/11/23 Java/Android