站长百科 | 数字化技能提升教程 数字化时代生存宝典
首页
数字化百科
电子书
▼
建站程序
开发
服务器
办公软件
开发教程
▼
服务器教程
软件使用教程
运营教程
热门电子书
▼
CSS教程
WordPress教程
导航
程序频道
推广频道
网赚频道
人物频道
网站程序
网页制作
云计算
服务器
CMS
论坛
网店
虚拟主机
cPanel
网址导航
WIKI使用导航
WIKI首页
热点词条
最新资讯
网站程序
站长人物
页面分类
使用帮助
编辑测试
创建条目
网站地图
站长百科导航
站长百科
主机侦探
IDCtalk云说
跨境电商导航
WordPress啦
站长专题
网站推广
网站程序
网站赚钱
虚拟主机
cPanel
网址导航专题
云计算
微博营销
虚拟主机管理系统
开放平台
WIKI程序与应用
美国十大主机
编辑“
WordPress:Inline Documentation
”(章节)
人物百科
|
营销百科
|
网赚百科
|
站长工具
|
网站程序
|
域名主机
|
互联网公司
|
分类索引
跳转至:
导航
、
搜索
警告:
您没有登录。如果您做出任意编辑,您的IP地址将会公开可见。如果您
登录
或
创建
一个账户,您的编辑将归属于您的用户名,且将享受其他好处。
反垃圾检查。
不要
加入这个!
== 函数 PHPdoc == WordPress 函数 PHPdoc类型包括短描述和长描述(如果适用的话). 短描述必须包括只带括号'()'的函数名字。短描述不应该重复说名函数名是什么,而应该深入一些描述这个函数是做什么的(代码)并作总结。函数名字可能表达了什么,但事实上做的却是完全不同的东西(规格改变了但是用法没有变)。 短描述要求完全考虑到这个函数的文献资料。在特殊情况下可能会留下记录,如下,让人知道短描述丢失了。 长描述应该包含在大多数的函数中,来清楚地给出短描述包含的意思。大多数情况下,摘要只是作为在长描述中编码器读取的提示。 极少情况下,函数非常的短,摘要就可以描述全部的函数目的范围了。这取决于文献资料作者的判断,但是作为一个规则,应该尝试吧长描述包括到PHPdoc 模块中去。 <</pre> 如果函数没有参数,或者返回资料留下短和长描述丢失的记录,这是可以接受的。这只能在你为一个多重函数写资料时,留下一个你专门为别人或者你自己留下空白以便将来完成的记录时,才可以使用。 <pre> /** * function_name() - {{@internal Missing Short Description}}} * * {{@internal Missing Long Description}}} * */ </pre> 对于其他提醒你或者你本不想留下空白的标签。其他时候,它应该被认为是有人故意留下空白,或者是不认为描述对于别人理解函数是必须的。信息可能并不服务于某种目的,如果在别的地方也可以找到的话。如,在使用@uses标签时,如果全局变量已经拥有资料时。 <pre> * @uses function_name() {{@internal Missing Description}}}</pre> 在短和长描述后,别的信息对于编码器和phpDocumentor 站点也是很重要的。 <pre> /** * function_name() - Short Description * * Long Description * * @package WordPress * @since version * * @param type $varname Description * @return type Description */ </pre> @since的惯例是只使用版本号,"2.1",或者"2.3.1",并且停止其他的字符串。 @package 信息给出了编码器和请求函数用的phpDocumentor,这样@since 就会请求属于它的版本号。 为了保持一致,如果参数可用,它们必须为每个函数建立资料文献。如果"return" 关键词在函数中的任何地方使用,那么@return标签应该被用来建立可能的资料。 如果它不存在的话,最好就不要包含这个标签,因为如果它存在,读者可能希望它能有 "return" 这个关键词。 如果函数被反对,就不应该继续使用了,然后会给出@deprecated 标签连同版本和使用哪些作为替代的描述。同样包括带有函数名字的@uses标签。 <pre> /** * ... Descriptions * * @deprecated 2.1 Use function_name() instead. * @uses function_name() * * ... parameters and return descriptions */ </pre>
摘要:
请注意,您对站长百科的所有贡献都可能被其他贡献者编辑,修改或删除。如果您不希望您的文字被任意修改和再散布,请不要提交。
您同时也要向我们保证您所提交的内容是您自己所作,或得自一个不受版权保护或相似自由的来源(参阅
Wordpress-mediawiki:版权
的细节)。
未经许可,请勿提交受版权保护的作品!
取消
编辑帮助
(在新窗口中打开)