完美解决phpdoc导出文档中@package的warning及Error的错误_php技巧
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了完美解决phpdoc导出文档中@package的warning及Error的错误_php技巧,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含3348字,纯文字阅读大概需要5分钟。
内容图文
今天在编写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的错误就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。
内容总结
以上是互联网集市为您收集整理的完美解决phpdoc导出文档中@package的warning及Error的错误_php技巧全部内容,希望文章能够帮你解决完美解决phpdoc导出文档中@package的warning及Error的错误_php技巧所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。