PHP编程：PHP文档东西
参加PHP开发学习，或许只是一次偶然的想法吧！只是想在走向社会之前体验、学习在一个公司或者说是项目团队之中如何去更有效的沟通、交流、共同合作，还有就是为毕业实习找工作增加伐码。 写文档是一项有趣却不能不做的任务，而编写API级的文档更是意味着大批的反复休息和难以坚持的分歧性。这里咱们要保举给人人的，是撑持PHP5语法剖析的文档东西――phpDocumentor。利用phpDocumentor不但可以主动从代码中提掏出函数和办法界说，还可以主动处置各个class之间的关系，并据今生成class tree。你还可以选择将文档生成html、chm或pdf。有了phpDocumentor，文档任务变得轻松了良多。
装置phpDocumentor
在pear下装置phpDocumentor是一件极为复杂的工作，只需求在cmd窗口中cd 到php装置目次下，然后输出
Pear install phpDocumentor
Pear就会本人下载并完成phpDocumentor的装置。
在phpDocumentor胜利装置后，php装置目次下会多出来一个phpdoc.bat。这个文件就是咱们用来生成文档的批处置文件了。
<? 相干常识 ?>
phpDocumentor是phpDoc的晋级版本，是专门为撑持php5语法而重写的文档东西，当你的php版本为5时，运转phpDoc.bat，它会主动去挪用phpDocumentor。所以文章中的提到的phpDoc和phpDocumentor实践上是不异的。
在phpdoc.bat地点目次下，输出
Phpdoc Ch
会失掉一个phpDocumentor的具体参数列表。
咱们从个中选出几个经常使用的来看看：
<? 号令注释 ?>
-f
要停止剖析的文件名，多个文件用逗号朋分
-d
要剖析的目次，多个目次用逗号朋分
-t
生成的文档的寄存途径
-o
输入的文档格局，布局为输入格局:转换器名:模版目次，例如：HTML:frames:phpedit
咱们会用到的就这几个了，其他的号令请人人浏览help的提醒信息。
试用phpDocumentor
上面咱们就以pear中的phpUnit2为例，演示一下若何利用phpDocumentor来生成文档。
起首，把咱们需求的参数肯定上去：
<? 号令参数 ?>
-d
C:\Program Files\EasyPHP5\php\PEAR\PHPUnit2
-t
C:\Program Files\EasyPHP5\php\phpunit2doc
-o
HTML:frames:phpedit
依据上边的参数，咱们组合出下边的号令：
Phpdoc -d “C:\Program Files\EasyPHP5\php\PEAR\PHPUnit2” -t “C:\Program Files\EasyPHP5\php\phpunit2doc” -o “HTML:frames:phpedit”
运转上边的号令后，phpDocumentor入手下手解析源文件并输入任务信息。
号令运转完成后，咱们的文档就已生成好了。 进入咱们指定的方针目次，用阅读器翻开index.html就能够看见生成的文档了。 文档界面由frame分红了三个局部，左上是包信息，左下是导航信息，右侧则是具体的信息出现页。
上边的图很清晰地描写出了文档的内容：
索引、函数列表、类列表、文件列表和子包。
点击上边的class(es)链接，咱们可以明晰的看见全部包的class tree。
咱们点击个中一个class，就进入了class的描写页面。
Class描写页面次要包括以下几方面内容：
l 描写：版权、作者、类条理等
l 类变量
l 类常量
l 办法
l 承继的变量
l 承继的办法：十分有效的一个功效
怎样，是否是很具体呢？假如要生成chm，可以把前边的-o参数改成”CHM:default: default”，如许phpDocumentor会为你生成好chm项目文件，只需用微软的chm东西停止编译就能够失掉可用的chm文件了。
用phpDocumentor为本人的代码生成文档
固然phpDocumentor可以主动从代码平分析出一些信息，然而，要构成一份详实的文档仍是需求咱们在编码中停止共同的。为了让phpDocumentor读懂咱们的代码，咱们需求注重一些编码标准和在正文中增添一些tag：
<? Tags ?>
@author
作者信息
@const
由define界说的常量
@deprecate
不建议利用的API
@global
全局变量
@package
包信息
@param
函数参数
@return
前往值
@see
参考函数
@since
引入工夫
@static
静态变量
@var
类成员变量
这里只是复杂的列出了经常使用的一些Tag，人人可以浏览phpDocumentor的文档，里边有十分具体的编码标准。关于phpDocumento就引见到这里，但愿人人都能好好使用这个东西来标准本人的文档。
PS：phpDocumentor也有Web界面的，你可以会见http://phpdoc.org获得Web版本。Web版本的装置很复杂，直接放到web可以会见的目次就能够运转了。
<? 情况请求 ?>
PHP：5.0.0
OS: 平台自力，本文演示OS为windows
在我开始学习PHP以前，我从未想过要做软件工程，即便是在去听过华育国际的关于软件工程的美好前景后，因为我一直都没有想过要与代码打交道，而是想学好所学专业，做个网络工程师或者是网络安全人员。 基础有没有对学习php没有太大区别，关键是兴趣。 其实也不算什么什么心得，在各位大侠算是小巫见大巫了吧，望大家不要见笑，若其中有错误的地方请各位大虾斧正。 多看优秀程序员编写的代码，仔细理解他们解决问题的方法，对自身有很大的帮助。 因为blog这样的可以让你接触更多要学的知识，可以接触用到类，模板，js ，ajax 本文当是我的笔记啦，遇到的问题随时填充 php是动态网站开发的优秀语言，在学习的时候万万不能冒进。在系统的学习前，我认为不应该只是追求实现某种效果，因为即使你复制他人的代码调试成功，实现了你所期望的效果，你也不了解其中的原理。 首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。 因为blog这样的可以让你接触更多要学的知识，可以接触用到类，模板，js ，ajax 建数据库表的时候，int型要输入长度的，其实是个摆设的输入几位都没影响的，只要大于4就行，囧。 再就是混迹于论坛啦，咱们的phpchina的论坛就很强大，提出的问题一般都是有达人去解答的，以前的帖子也要多看看也能学到不少前辈们的经验。别的不错的论坛例如php100，javaeye也是很不错的。 当留言板完成的时候，下步可以把做1个单人的blog程序，做为目标， 如果你可以写完像留言板这样的程序，那么你可以去一些别人的代码了， 使用 jquery 等js框架的时候，要随时注意浏览器的更新情况，不然很容易发生框架不能使用。 遇到出错的时候，我经常把错误信息直接复制到 google的搜索栏，一般情况都是能搜到结果的，不过有时候会搜出来一大片英文的出来，这时候就得过滤一下，吧中文的弄出来，挨着式方法。 开发工具也会慢慢的更专业，每个公司的可能不一样，但是zend studio是个大伙都会用的。 开发工具也会慢慢的更专业，每个公司的可能不一样，但是zend studio是个大伙都会用的。 首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。 在我安装pear包的时候老是提示，缺少某某文件，才发现 那群extension 的排列是应该有一点的顺序，而我安装的版本的排序不是正常的排序。没办法我只好把那群冒号加了上去，只留下我需要使用的扩展。 学习php的目的往往是为了开发动态网站，phper就业的要求也涵盖了很多。我大致总结为：精通php和mysql
页:
[1]
2