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

 更新时间:2016年05月17日 17:09:16   投稿:jingxian  
下面小编就为大家带来一篇完美解决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的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 使用HMAC-SHA1签名方法详解

    使用HMAC-SHA1签名方法详解

    本篇文章是对使用HMAC-SHA1的签名方法进行了详细的分析介绍,需要的朋友参考下
    2013-06-06
  • php计算到指定日期还有多少天的方法

    php计算到指定日期还有多少天的方法

    这篇文章主要介绍了php计算到指定日期还有多少天的方法,涉及php操作时间的技巧,非常具有实用价值,需要的朋友可以参考下
    2015-04-04
  • php json与xml序列化/反序列化

    php json与xml序列化/反序列化

    在WEB开发中,php对象的序列化与反序列化经常使用,比较主流的有json格式与xml格式的序列化与反序列化。今天我们就来看看是如何用的。
    2013-10-10
  • PHP中file_get_contents设置header请求头,curl传输选项参数详解说明

    PHP中file_get_contents设置header请求头,curl传输选项参数详解说明

    php中远程获取和采集内容、实现PHP网页版的FTP上传下载、实现模拟登陆、实现接口数据传输(API)、实现模拟Cookie、下载文件断点续传等等,都会用到fopen、file_get_contents和curl这样的函数,当然要对比一下了,程序架构设计当然要无可挑剔了。
    2023-07-07
  • PHP的PDO操作简单示例

    PHP的PDO操作简单示例

    这篇文章主要介绍了PHP的PDO操作,以简单示例形式分析了PHP操作PDO的简单连接,初始化及查询,插入等操作技巧,需要的朋友可以参考下
    2016-03-03
  • php修改word的实例方法

    php修改word的实例方法

    在本篇文章里小编给大家整理的是一篇关于php修改word的实例方法,有兴趣的朋友们可以跟着学习参考下。
    2021-11-11
  • php文件缓存类汇总

    php文件缓存类汇总

    这篇文章主要介绍了php文件缓存类,实例汇总了常见的文件缓存类及其用法,非常具有实用价值,需要的朋友可以参考下
    2014-11-11
  • PHP基础知识介绍

    PHP基础知识介绍

    这篇文章介绍了PHP的一些基础知识,有需要的朋友可以参考一下
    2013-09-09
  • php生成静态文件的多种方法分享

    php生成静态文件的多种方法分享

    最近需要将自己写的php文件生成静态,经过查找,发现有多种方法,不同需求可以选择不同的方法
    2012-07-07
  • PHP的cURL库功能简介 抓取网页、POST数据及其他

    PHP的cURL库功能简介 抓取网页、POST数据及其他

    本文介绍了PHP的cURL库的几个使用方法。cURL是一个功能强大的PHP库,可以用于获取网页内容,获取网页内容以及取一个XML文件并把其导入数据库等等。
    2011-04-04

最新评论