php注释规范
web PHP 2024-04-03 222 0
关于本站

“最难不过坚持”

本人承接扒站仿站,php网站维护,病毒查杀,网站编辑,网站改版,html制作

有需要网站维护,改版,病毒查杀,网站编辑,网站备案,html制作等相关的工作可以联系我。
本人有多年相关工作经验,也可提供免费咨询,交个朋友。
有需要探讨问题的朋友,也可以加我微信,共同探讨!
微信:15011482830 QQ:408917339

6519703 2619 39
最新评论
https://jueru.net/
评 留言
:weixiao:
评 留言
:shuijiao: :weiqu: :zhenbang: :leng:
评 留言
:yiwen: :yiwen: :yiwen: :yiwen:
评 EasySass: could not generate CSS file. See Output panel for details.
这个业务逻辑多少都有点奇怪了,阅读浏览次数增值在新闻详情页的控制器方法里setInc,这怎么还写进模型事件里了。如果非要用onAfterRead也可以,把新闻文章的内容单独分出来一个news_content表,然后把它和news做关联,然后给news_content表的onAfterRead事件做增值处理,这样点进新闻页内查询到文章内容时才会触发它。
评 TP6模型事件-查询后onAfterRead不好用
文章标签更多
ThinkPHP (254)
Mysql (58)
DedeCms (33)
jQuery (67)
证件照 (1)
setInc (4)
setDec (4)
onclick (5)
打开边栏(ESC) 关闭边栏(ESC)

@api

表示这是一个提供给第三方使用的API接口

@author

作者

格式@author [名称] [<邮箱>]

例如@author mokeyjay <i@mokeyjay.com>

@copyright

版权声明。例如很多网站底部都有

格式@copyright [描述]

例如@copyright 1949-2016 China

@deprecated

不建议使用的、已过期的、将被删除的

格式@deprecated [<版本号>] [<描述>]

例如@deprecated 1.0.0 新版本将不再包含此函数

如果它是被其他方法所取代了,建议添加@see标记

@example

例子、示例、用例。也可表示方法返回值的例子

格式@example [位置] [<起始行号> [<行数>] ] [<描述>]

例如@example demo.php 10 3 使用示例

@filesource

没看懂,如果你们看懂了请告诉我。传送门

@global

全局变量

格式@global [类型][名称] @global [类型][描述]

我怀疑这里是源文档打错了,大概应该是

格式@global [类型][名称][描述]

类型@global string name 用户名

@ignore

忽略

格式@ignore [<描述>]

例如你在if和else的语句块中定义分别同一个变量但值不同时,可以通过此标记让phpDocumentor忽略其中一个,以免生成重复的文档。例如

if ($ostest) {

  /**

  * This define will either be 'Unix' or 'Windows'

  */

  define("OS","Unix");

} else {

  /**

  * @ignore

  */

  define("OS","Windows");

}

@internal

仅限内部使用的

格式@internal [描述]

例如@internal 仅限内部测试使用

@license

协议,很常见的啦

格式@license [<url>] [名称]

例如@license GPL

@link

链接,可用于辅助说明、引用文档等

格式@link [url] [<描述>]

例如@link http://g.cn 不懂滚去问谷歌,别来烦我

@method

方法。这是用在类注释里的标记。特别适合一些动态加载的类,IDE无法自动提示出来,这时就可以通过写@method标记来告诉IDE我这类里有哪些方法

格式@method [返回值类型] [名称]([[类型] [参数]<, ...>]) [<描述>]

例如@method string google(string $question) 向谷歌提问,返回答案内容

@package

包。但php没有包,所以就用来表示命名空间

例如@package yii\base\db

@param

参数,用于函数和方法注释里的标记

格式@param [Type] [name] [<description>]

例如@param string title 文章标题

@property

类属性,与@method类似,可以告诉IDE我这类里有哪些属性

格式@property [Type] [name] [<description>]

例如@property int id 用户id

@property-read

只读的属性。例如__get魔术方法能够取到的属性

格式@property-read [Type] [name] [<description>]

例如@property-read int id 用户id

@property-write

只可写的属性。例如__set魔术方法能够设置的属性

格式@property-write [Type] [name] [<description>]

例如@property-write string name 用户名

@return

返回值

格式@return [类型] [<描述>]]

例如@return array 结果数组

@see

参考,类似@link,可与@deprecated联动

格式@see [url或完整方法名] [<描述>]

例如@see \yii\base\db::tableName() 旧方法table_name已弃用,请使用此方法替代

@since

从xx版本开始。例如从1.0之后添加了xx功能、删除了xx参数等

格式@since [1.0.0] [<描述>]

例如@since 1.0.2 添加了$b参数

@source

没看懂,如果你们看懂了请告诉我。传送门

@throws

可能会抛出的错误类型

格式@throws [类型] [<描述>]

例如@throws LifeException 没钱了,好想死啊

@todo

待办。提示自己或他人还需要做些什么

格式@todo [描述]

例如@todo 这个类还没做异常处理

@uses

使用

格式@uses [完整方法名] [<描述>]

例如@uses \yii\base\db::$count 使用此属性计数

@var

变量

格式@var [类型] [变量名] [<描述>]

例如@var int id 用户id

@version

版本号

格式@version [<载体>] [<描述>]

例如@version 1.0.1 2016-07-03更新

或者@version GIT:1f3197d01 来自GIT分支1f3197d01

版权声明:本篇文章来源于网络。 来源链接

相关推荐
php实现ZIP压缩文件解压缩,中文乱码解决方法(重要)
PHP | 2019-04-30 5677
直接上代码,具体代码里面都有注释。直接中文压缩文件解压到中文文件夹。 <?php // 需开启配置 php_zip.dll // phpinfo(); header("Content-type:text/html;charset=utf-8"); /* * $filename 被解压文件名 * $path 解压...
openssl_private_decrypt解密失败
PHP | 2019-01-16 5627
复制别人的解密程序,原程序可以解密,复制过来就不可以 一步步尝试发现,秘钥换行符有区别, 原秘钥有换行符,复制过来不知道什么时候把换行符清空了,成了一行字符串了。
评论:0条
评论加载中...
发表评论
后一篇: