完美解决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的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • PHP设计模式之模板模式定义与用法详解

    PHP设计模式之模板模式定义与用法详解

    这篇文章主要介绍了PHP设计模式之模板模式定义与用法,较为详细的说明了模板模式的原理、功能、应用及php定义、使用模板模式的相关操作技巧,代码简单易懂,需要的朋友可以参考下
    2018-12-12
  • 深入讲解PHP Session及如何保持其不过期的方法

    深入讲解PHP Session及如何保持其不过期的方法

    这篇文章主要介绍了深入讲解PHP Session及如何保持其不过期的方法,包括对Session回收机制的讲解以及SessionId保持不变的问题的解决,需要的朋友可以参考下
    2015-08-08
  • 详解WordPress开发中wp_title()函数的用法

    详解WordPress开发中wp_title()函数的用法

    这篇文章主要介绍了WordPress开发中wp_title()函数的用法,wp_title可以用来显示文章标题和分类名称等,需要的朋友可以参考下
    2016-01-01
  • PHP SPL标准库中的常用函数介绍

    PHP SPL标准库中的常用函数介绍

    这篇文章主要介绍了PHP SPL标准库中的常用函数介绍,本文着重讲解了spl_autoload_extensions()、spl_autoload_register()、spl_autoload()三个函数,需要的朋友可以参考下
    2015-05-05
  • 计算一段日期内的周末天数的php代码(星期六,星期日总和)

    计算一段日期内的周末天数的php代码(星期六,星期日总和)

    算法没什么难点,核心思想就是将这个时间段调整为7的整数,然后乘以2,在减去或加上多算和少算的周六或周日,得到的就是星期六和星期日的总和。
    2009-11-11
  • PHP实现非阻塞模式的方法分析

    PHP实现非阻塞模式的方法分析

    这篇文章主要介绍了PHP实现非阻塞模式的方法,结合实例形式分析了php非阻塞模式的原理、实现方法及相关操作注意事项,需要的朋友可以参考下
    2018-07-07
  • PHP 引用是个坏习惯

    PHP 引用是个坏习惯

    在写PHP 程序的时候,很多人在传递参数的时候,喜欢用一个引用。特别是在一个数组非常的大的时候,更是喜欢加。
    2010-03-03
  • PHP中使用unset销毁变量并内存释放问题

    PHP中使用unset销毁变量并内存释放问题

    PHP的unset()函数用来清除、销毁变量,不用的变量,我们可以用unset()将它销毁。但是某些时候,用unset()却无法达到销毁变量占用的内存!
    2012-07-07
  • php一个找二层目录的小东东

    php一个找二层目录的小东东

    碰到个虚拟主机,iis7.0.里边有上万个站,只有脚本权限,没命令行权限,但是可以跨目录写文件.如果能得到目标站的物理目录,能立马搞定.但是想尽一切办法,也没找到物理路径.所以只有用脚本找了.手工找会累死的.一个php是找的,一个asp是写的
    2012-08-08
  • php遍历目录方法小结

    php遍历目录方法小结

    这篇文章主要介绍了php遍历目录方法,实例总结了常用的两种实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03

最新评论