仓酷云

标题: PHP网页编程之若何文档化你的PHP类(二) [打印本页]

作者: 活着的死人 时间: 2015-2-3 23:53
标题: PHP网页编程之若何文档化你的PHP类(二)
实现固定数量的几张图片的上传；再如调试软件ZendStudio的使用，看了很多次老师的应用，但总感觉用的不顺手，不懂那么多的数据值，到底哪一个才是真正的问题所在；还有如数据库语句的封装，我只会用简单的函数来进行封装。若何文档化你的PHP类(二)

[br]
作者：stefano Locati 翻译：limodou

文档化函数或办法
　　成员函数或办法利用@function标志被文档化。

--------------------------------------------------------------------------------
/*! @function getItemingroup
@abstract gets a bagitem of a given group and a given position
@param groupno int - the delivery group ordinal position in the bag
@param pos    int - the position of the bagitem within the group
@result Object - the BagItem in a given position of given group
or -1 if it could not be found
*/
--------------------------------------------------------------------------------

文档化一个办法。

　　@function标志声了然一个函数而且前面随着函数或成员函数名。然后你可以象后面一样利用 @abstract和@discussion标志。但是还有两个额定的标志。@param标志用于描写函数的参数；第一个词假定为变量的名字，其它的则为恣意的文本描写。我建议要声明想要的变量类型，虽然PHP不是一个强类型言语。 @result标志被用于描写前往值。

文档化变量
　　变量或类变量都利用@var标志来描写。在这个标志中，第一个词被以为是变量的名字，同时其它的则为恣意的文本描写。象后面一样，我建议写出所希冀的变量类型是好的做法。它也是一个文档化一切类变量的好主张。

文档化一个类变量。

--------------------------------------------------------------------------------
/*! @var idsession string - an unique session identifier */
var $idsession;
--------------------------------------------------------------------------------
最初接触
--------------------------------------------------------------------------------
/*! @header myprojectname
@abstract a virtual store to shop on mars
@discussion The difference [...]
*/
--------------------------------------------------------------------------------
　　@header标志用来供应一些关于被文档化的项目或类组的普通性信息。@header标志自己随着项目标名字，并且可以用@abstract标志和@discussion标志来增补申明。由于类凡是存在于分歧的文件中（一个文件一个类，且用类的名字给文件名字是一种好的设法），你能够想晓得应当将@header 标志放在甚么中央。谜底很让人受惊，哪都可以。我的建议是：假如它对照长就把它放在一个自力的文件中，或假如是一个冗长的申明就把它放在最主要的类的后面。

若何修正剧本用于PHP
　　从Apple失掉的初始的HeaderDoc剧本是用于C或C++头文件的，所以要用在PHP中需求对它做一些小修改。假如你对细节没有乐趣，你可以从这里下载，而且跳过上面局部。
　　修正源法式所做的独一的工作就是在主perl文件中，使剧本可以承受.php和.php3后缀。

--------------------------------------------------------------------------------
$ diff headerDoc2HTML.pl /usr/local/bin/headerdoc2html
195c195
<    ($rootFileName = $filename) =~ s/.(h|i)$//;
---
>    ($rootFileName = $filename) =~ s/.(h|i|php|php3)$//;
--------------------------------------------------------------------------------
运转剧本
　　在装置完剧本以后，假定你的类放在classes子目次下，而且你想将生成的文档放在docs目次下，你应当履行这个号令：

headerdoc2html -o docs classes/*.php

　　不幸的是假如存在多个PHP文件，这个剧本有一个坏习气就是将那些文件朋分到分歧的目次中去，使得在类的文档中阅读变得很坚苦。并且由于初始的剧本是为C/C++头文件所写的（头文件中只要类和函数的声明而没有他们的界说），剧本会将函数名下的一切代码输入，直到碰着";"，所以典范的就是代码的第一行。

　　然而在你十分困难读到如今却感应失望之前，抓紧，由于我写了一段复杂的剧本来处理这两个成绩。

--------------------------------------------------------------------------------
cat classes/*.php | sed 's/ *{/;#{/g' | tr "#" "
" > docs/all.php
headerdoc2html -o docs docs/all.php
rm docs/all.php
--------------------------------------------------------------------------------
　　假如你想晓得为何我在这里利用tr号令而不是都用sed来做，缘由就是用在依然用在RedHat 6.2上的sed 3.02版本不处置换行符。应当交换成新的版本sed 3.02a。假如你对sed感乐趣，可以看SED FAQ。

　　祝你的文档化任务好运！

翻译后话：
　　因为这篇文章是在Linux情况下利用的，所以在windows下的利用能够会有成绩。我会试一试，能想举措就想了，其实想不出来也没有举措了。

原作者：limodou
来历：PHPX
  你的留言本应该加入注册以及分页功能了，而如果你更强的话，UI(用户界面)也可以加强，完成之后，感觉是不是特有成就感?不管怎么样，咱好歹是写了一个动态网站程序了，放在自己的网站上耍耍吧。

作者: 海妖 时间: 2015-2-4 06:56
我学习了一段时间后，我发现效果并不好（估计是我自身的问题）。因为一个人的精力总是有限的，同时学习这么多，会导致每个的学习时间都得不到保证。

作者: admin 时间: 2015-2-4 16:25
多看优秀程序员编写的代码，仔细理解他们解决问题的方法，对自身有很大的帮助。

作者: 深爱那片海 时间: 2015-2-6 21:14
Apache不是非得用80或者8080端口的，我刚开始安得时候就是80端口老占用，就用了个 81端口，结果照常，就是输localhost的时候，应该输入为 localhost:81

作者: 分手快乐 时间: 2015-2-18 19:34
这些中手常用的知识，当你把我说的这些关键字都可以熟练运用的时候，你可以选择自己

作者: 再见西城 时间: 2015-3-6 09:23
学习php的目的往往是为了开发动态网站，phper就业的要求也涵盖了很多。我大致总结为：精通php和mysql

作者: 小魔女 时间: 2015-3-6 22:13
首推的搜索引擎当然是Google大神，其次我比较喜欢百度知道。不过搜出来的结果往往都是大家copy来copy去的，运气的的概率很大。

作者: 再现理想 时间: 2015-3-8 19:35
开发工具也会慢慢的更专业，每个公司的可能不一样，但是zend studio是个大伙都会用的。

作者: 谁可相欹 时间: 2015-3-11 13:58
首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。

作者: 因胸联盟 时间: 2015-3-13 06:10
说php的话，首先得提一下数组，开始的时候我是最烦数组的，总是被弄的晕头转向，不过后来呢，我觉得数组里php里最强大的存储方法，所以建议新手们要学好数组。

作者: 若天明 时间: 2015-3-20 14:50
最后祝愿，php会给你带来快乐的同时你也会给他带来快乐。

作者: 莫相离 时间: 2015-3-27 21:11
其实没啥难的，多练习，练习写程序，真正的实践比看100遍都有用。不过要熟悉引擎

作者: 简单生活 时间: 2015-4-5 10:50
首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。

作者: 冷月葬花魂 时间: 2015-4-10 11:13
如果你可以写完像留言板这样的程序，那么你可以去一些别人的代码了，

作者: 爱飞 时间: 2015-4-11 15:12
最后祝愿，php会给你带来快乐的同时你也会给他带来快乐。

作者: 小女巫 时间: 2015-4-22 01:22
装在C盘下面可以利用windows的ghost功能可以还原回来（顺便当做是重转啦），当然啦我的编译目录要放在别的盘下，不然自己的劳动成果就悲剧啦。

作者: 精灵巫婆 时间: 2015-4-26 22:45
本人接触php时间不长，算是phper中的小菜鸟一只吧。由于刚开始学的时候没有名师指，碰过不少疙瘩，呗很多小问题卡过很久，白白浪费不少宝贵的时间，在次分享一些子的学习的心得。

作者: 活着的死人 时间: 2015-5-2 11:37
说点我烦的低级错误吧，曾经有次插入mysql的时间弄了300年结果老报错，其实mysql的时间是有限制的，大概是到203X年具体的记不清啦，囧。

作者: 若相依 时间: 2015-5-7 14:57
没接触过框架的人，也不用害怕，其实框架就是一种命名规范及插件，学会一个框架其余的框架都很好上手的。

作者: 山那边是海 时间: 2015-5-8 00:25
学好程序语言，多些才是王道，写两个小时代码的作用绝对超过看一天书，这个我是深有体会（顺便还能练打字速度）。

作者: 变相怪杰 时间: 2015-6-6 09:24
曾经犯过一个很低级的错误，我在文件命名的时候用了一个横线\\\\\\\'-\\\\\\\' 号，结果找了好几个小时的错误，事实是命名的时候是不能用横线 \\\\\\\'-\\\\\\\' 的，应该用的是下划线 \\\\\\\'_\\\\\\\' ;

欢迎光临仓酷云 (http://ckuyun.com/)