站长百科 | 数字化技能提升教程 数字化时代生存宝典
首页
数字化百科
电子书
▼
建站程序
开发
服务器
办公软件
开发教程
▼
服务器教程
软件使用教程
运营教程
热门电子书
▼
CSS教程
WordPress教程
导航
程序频道
推广频道
网赚频道
人物频道
网站程序
网页制作
云计算
服务器
CMS
论坛
网店
虚拟主机
cPanel
网址导航
WIKI使用导航
WIKI首页
热点词条
最新资讯
网站程序
站长人物
页面分类
使用帮助
编辑测试
创建条目
网站地图
站长百科导航
站长百科
主机侦探
IDCtalk云说
跨境电商导航
WordPress啦
站长专题
网站推广
网站程序
网站赚钱
虚拟主机
cPanel
网址导航专题
云计算
微博营销
虚拟主机管理系统
开放平台
WIKI程序与应用
美国十大主机
编辑“
WordPress内嵌文档
”(章节)
人物百科
|
营销百科
|
网赚百科
|
站长工具
|
网站程序
|
域名主机
|
互联网公司
|
分类索引
跳转至:
导航
、
搜索
警告:
您没有登录。如果您做出任意编辑,您的IP地址将会公开可见。如果您
登录
或
创建
一个账户,您的编辑将归属于您的用户名,且将享受其他好处。
反垃圾检查。
不要
加入这个!
===函数PHPdoc=== WordPress函数PHPdoc类型描述文档可短可长(如果合适的话)。 简短的描述不应再提及函数名称,而应直接概括函数的功能。要注意的是函数名称和功能可能并不吻合(名称和描述文字可能改变,但功能却不会变)。 但函数简短的文档描述内容也要完整。在某些情况下,也可注明简短描述缺失,如: /** * Short Description 大多数函数都使用较长描述来详细说明简短描述的含义。多数情况下,摘要(summary)只是作为较长描述的引子。 有时,函数非常短,只用摘要就能描述函数的所有功能。这可由内嵌文档撰写者自主判断,但是通常情况下应该在PHPdoc块中应编写较长的注释。 /** * Short Description * * Long Description * */ 如果函数没有包括参数或返回文档来说明文档注释缺失,这也是可以接受的。但这只有在为多个函数编写内嵌文档时才能使用,而且应该留下一个说明(note)以示你是有意暂时没有添加文档描述,以待他人或你自己以后编写。 /** * { {@internal Missing Short Description}}} * * { {@internal Missing Long Description}}} * */ 另外,还可使用其它标签来提醒自己或告诉他人你并非有意不写内嵌文档。其它情况下,如果内嵌文档为空,通常认为他们有意留空,或认为没有必须添加注释,因为他人可以理解这个函数。如果在别处可以得知函数功能,那么内嵌文档也就没有存在的意义了。例如,如果全局变量已有内嵌文档了,@uses 标签无需再添加注释了。 * @uses function_name() { {@internal Missing Description}}}对程序员和phpDocumentor 网站较为重要的其它信息: /** * Short Description * * Long Description * * @package WordPress * @since version * * @param type $varname Description * @return type Description */ @since 只和版本号连用,如 "2.1", 或 "2.3.1",而且不使用其它字符串。@package信息用来给程序员和phpDocumentor 提供函数的应用信息,因此, 版本号码属于 @since。 为统一起见,如果可使用参数,每个函数的应该备注参数。如果函数使用了"return",那么"return"标签就应该用来注释这个函数。如果没有使用"return",就尽量不要 包括这个标签,因为如果存在,读者就会期望看到"return"这个关键词。 不要使用已过时的函数,而应标注版本的@deprecated标签和替代函数说明,还应包括@uses标签和函数名称。 /** * ... Descriptions * * @deprecated 2.1 Use function_name() instead. * @uses function_name() * * ... parameters and return descriptions */
摘要:
请注意,您对站长百科的所有贡献都可能被其他贡献者编辑,修改或删除。如果您不希望您的文字被任意修改和再散布,请不要提交。
您同时也要向我们保证您所提交的内容是您自己所作,或得自一个不受版权保护或相似自由的来源(参阅
Wordpress-mediawiki:版权
的细节)。
未经许可,请勿提交受版权保护的作品!
取消
编辑帮助
(在新窗口中打开)