|
马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有帐号?立即注册
x
实现固定数量的几张图片的上传;再如调试软件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(用户界面)也可以加强,完成之后,感觉是不是特有成就感?不管怎么样,咱好歹是写了一个动态网站程序了,放在自己的网站上耍耍吧。 |
|