phpstrom自定义注释
汉化:
1.点file文件。2.点settings,打开设置。3.搜索chinese关键字,查找中文汉化插件。 4.安装完后重启phpstorm。5.再次打开IDE汉化成功,正常显示中文了。(百度经验)
自定义注释:
打开设置--编辑器---文件和代码模板---包含
如图,这里面可以自定义设置注释, 比如 PHP Class Doc Commen 就是设置控制器的注释, 而PHP Function Doc Comment 则是设置方法的注释,这两个使用较多,剩余的就留给大家去探索了。
注释中自带有一些方法, 比如获取控制器的名字 ,${NAME} ,即可, 时间等等,可以下拉自行探索。 下文我会把一些PHPDoc的规范写下来。
如果没有对应的可以使用,怎么办,我们可以自定义,比如时间,我们找到实时模板, 点击右上角的+,选择模板组,自己创建一个
比如我创建的是Text,找到后选中,在点击右侧+,选择动态模板组,这里我创建的XXX,并输入模板文本,这里我以时间为例,其他的请小伙伴们自行研究,哈哈
然后选择更改, 把PHP加进去
然后选择编辑变量,按照我所写的,填进去即可,然后第三步,默认是tab,我习惯设置为了enter,这点的用处后文会说到。
回到文件和代码模板,关联刚才设置的动态模板, 这里的名字要跟动态模板名字一样,我这里用的是XXX,保存即可
接下来我们来试试效果, 输入/**点击回车(enter) 就可以输出注释了
这时候会发现,Data直接就是XXX,这里呢,就是上文说到的设置enter,不设置则默认tab,把鼠标放到XXX后, 敲下设置的按钮,我设置的是回车,看效果
时间出现了。 这样,我们自定义的注释就到此结束了, 时间的话,编辑器本身就自带有方法,可以直接使用,这样当你敲下 /** enter的时候,时间会自动出现的
好了,自定义注释方法到此就结束了,有兴趣的小伙伴可以多尝试下其他的,技术这玩意,就是不断的折腾嘛,接下来我说下PHPDoc的规范,当然也是我抄袭的,哈哈
@api
表示这是一个提供给第三方使用的API接口
@author
作者
格式@author [名称] [<邮箱>]
@copyright
版权声明。例如很多网站底部都有
格式@copyright [描述]
@deprecated
不建议使用的、已过期的、将被删除的
格式@deprecated [<版本号>] [<描述>]
@example
例子、示例、用例。也可表示方法返回值的例子
格式@example [位置] [<起始行号> [<行数>] ] [<描述>]
@global
全局变量
格式@global [类型][名称][描述]
@ignore
忽略
格式@ignore [<描述>]
@internal
仅限内部使用的
格式@internal [描述]
@license
协议,很常见的啦
格式@license [<url>] [名称]
@link
链接,可用于辅助说明、引用文档等
格式@link [url] [<描述>]
@method
方法。这是用在类注释里的标记。特别适合一些动态加载的类,IDE
无法自动提示出来,这时就可以通过写@method
标记来告诉IDE
我这类里有哪些方法
格式@method [返回值类型] [名称]([[类型] [参数]<, ...>]) [<描述>]
@package
包。但php没有包,所以就用来表示命名空间
@param
参数,用于函数和方法注释里的标记
格式@param [Type] [name] [<description>]
@property
类属性,与@method
类似,可以告诉IDE我这类里有哪些属性
格式@property [Type] [name] [<description>]
@property-read
只读的属性。例如__get
魔术方法能够取到的属性
格式@property-read [Type] [name] [<description>]
@property-write
只可写的属性。例如__set
魔术方法能够设置的属性
格式@property-write [Type] [name] [<description>]
@return
返回值
格式@return [类型] [<描述>]]
@see
参考,类似@link
,可与@deprecated
联动
格式@see [url或完整方法名] [<描述>]
@since
从xx版本开始。例如从1.0之后添加了xx功能、删除了xx参数等
格式@since [1.0.0] [<描述>]
@throws
可能会抛出的错误类型
格式@throws [类型] [<描述>]
@todo
待办。提示自己或他人还需要做些什么
格式@todo [描述]
@uses
使用
格式@uses [完整方法名] [<描述>]
@var
变量
格式@var [类型] [变量名] [<描述>]
@version
版本号
格式@version [<载体>] [<描述>]