PHP编程:PHPDocumentor 正文标准收拾
熟悉HTML/CSS/JS等网页基本元素,完成阶段可自行制作完整的网页,对元素属性达到熟悉程度你会写正文么?从我写代码入手下手,这个成绩就一向困扰着我,信任也一样困扰着其他同砚。之前的写正文老是没有一套卓有成效的尺度,给保护和协同开辟带了很多贫苦,直到比来读到了phpdocumentor的正文尺度。上面对phpdocumentor的正文尺度举行总结:
Type(数据范例):
[*]
[*]string字符串范例
[*]integerorint整型
[*]booleanorbool布尔范例trueorfalse
[*]floatordouble浮点范例
[*]object工具
[*]mixed夹杂范例没有指定范例或不断定范例时利用
[*]array数组
[*]resource资本范例(如数据库查询前往)
[*]void空值(把持器前往值常常利用)
[*]nullnull范例
[*]callable回调函数
[*]falseortrue只前往trueorfasle时利用
[*]self本身
Tags(标签):
Tag
Element
Description
api
Methods
声明接口
author
Any
作者信息
category
File,Class
将一系列的元素分类在一同
copyright
Any
版权信息
deprecated
Any
声明元素已被弃用,能够在未来的版本中删除
example
Any
示例
filesource
File
文件资本
global
Variable
声明一个选集变量
ignore
Any
疏忽以后元素(phpdocumentor天生文档时)
internal
Any
声明一个值为整形,大概设置一个使用的默许值为整型
license
File,Class
声明允许范例
link
Any
声明一个和以后元素有关的链接
method
Class
声明以后类那些把戏办法能够被挪用
package
File,Class
声明以后元素所属的包
param
Method,Function
声明以后元素的一个参数
property
Class
声明以后类有那些把戏办法能够被挪用属性
property-read
Class
声明以后类有那些把戏办法能够读取属性
property-write
Class
声明以后类有那些把戏办法能够设置属性
return
Method,Function
前往值
see
Any
申明以后元素参数援用于其他站点或元素
since
Any
声明以后元素始于于哪一个版本
source
Any,exceptFile
展现以后元素的源码
subpackage
File,Class
将当期元素分类
throws
Method,Function
申明以后元素抛出的非常
todo
Any
申明以后元素的开辟举动
uses
Any
援用一个联系关系元素
var
Properties
声明属性
version
Any
版本
Example(示例):
//=============================
@api
/***Thismethodwillnotchangeuntilamajorrelease.**@api**@returnvoid*/functionshowVersion(){<...>}
//=============================
@author
/***@authorMyName*@authorMyName*/
//=============================
@category
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/
//=============================
@copyright
/***@copyright1997-2005ThePHPGroup*/
//=============================
@deprecated
/***@deprecated*@deprecated1.0.0*@deprecatedNolongerusedbyinternalcodeandnotrecommended.*@deprecated1.0.0Nolongerusedbyinternalcodeandnotrecommended.*/functioncount(){<...>}
//=============================
@example
/***@exampleexample1.phpCountinginaction.*@examplehttp://example.com/example2.phpsCountinginactionbya3rdparty.*@exampleMyOwnExample.phpMycounting.*/functioncount(){<...>}
//=============================
@filesource
/***@filesource*/
//=============================
@globalphpdocumentor2.0不撑持
//=============================
@ignore
if($ostest){/***ThisdefinewilleitherbeUnixorWindows*/define(OS,Unix);}else{/***@ignore*/define(OS,Windows);}
//=============================
@internal
/***@internal**@returnintegerIndicatesthenumberofitems.*/functioncount(){<...>}
/***CountsthenumberofFoo.**{@internalSilentlyaddsoneextraFootocompensateforlackofFoo}}**@returnintegerIndicatesthenumberofitems.*/functioncount(){<...>}
//=============================
@license
/***@authorMyName*@authorMyName*/0
//=============================
@link
/***@authorMyName*@authorMyName*/1
/***@authorMyName*@authorMyName*/2
//=============================
@method
/***@authorMyName*@authorMyName*/3
//=============================
@package
/***@authorMyName*@authorMyName*/4
//=============================
@param
/***@authorMyName*@authorMyName*/5
//=============================
@property
/***@authorMyName*@authorMyName*/6
//=============================
@property-read
/***@authorMyName*@authorMyName*/7
//=============================
@property-write
/***@authorMyName*@authorMyName*/8
//=============================
@return
/***@authorMyName*@authorMyName*/9
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/0
//=============================
@see
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/1
//=============================
@since
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/2/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/3
//=============================
@source
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/4//=============================
@subpackage
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/5
//=============================
@throws
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/6
//=============================
@todo
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/7
//=============================
@uses
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/8
//=============================
@var
/***Page-LevelDocBlock**@categoryMyCategory*@packageMyPackage*/9
//=============================
@version
/***@copyright1997-2005ThePHPGroup*/0/***@copyright1997-2005ThePHPGroup*/1
你的确对PHP有兴趣,那么选择教材也是很重要的。 个人呢觉得,配wamp 最容易漏的一步就是忘了把$PHP$目录下的libmysql.dll拷贝到windows系统目录的system32目录下,还有重启apache。 不禁又想起那些说php是草根语言的人,为什么认得差距这么大呢。 Apache不是非得用80或者8080端口的,我刚开始安得时候就是80端口老占用,就用了个 81端口,结果照常,就是输localhost的时候,应该输入为 localhost:81 其实没啥难的,多练习,练习写程序,真正的实践比看100遍都有用。不过要熟悉引擎 Apache不是非得用80或者8080端口的,我刚开始安得时候就是80端口老占用,就用了个 81端口,结果照常,就是输localhost的时候,应该输入为 localhost:81 再就是混迹于论坛啦,咱们的phpchina的论坛就很强大,提出的问题一般都是有达人去解答的,以前的帖子也要多看看也能学到不少前辈们的经验。别的不错的论坛例如php100,javaeye也是很不错的。 其实没啥难的,多练习,练习写程序,真正的实践比看100遍都有用。不过要熟悉引擎 因为blog这样的可以让你接触更多要学的知识,可以接触用到类,模板,js ,ajax 其实也不算什么什么心得,在各位大侠算是小巫见大巫了吧,望大家不要见笑,若其中有错误的地方请各位大虾斧正。 其实没啥难的,多练习,练习写程序,真正的实践比看100遍都有用。不过要熟悉引擎
页:
[1]