|
马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有帐号?立即注册
x
熟悉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
//=============================
@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有兴趣,那么选择教材也是很重要的。 |
|