PhpStorm函数注释的设置
PhpStorm函数注释的设置
一、总结
一句话总结:
添加模板 添加变量
应用变量
a、添加模板,添加變量,在(PhpStorm中setting-》Editor-》Live Template)中添加模板添加變量
$DATE$ $TIME$
b、應用變量,在(setting-》Editor-》FIle and Code Template-》Includes)中應用變量
/*** Notes:* User: ${USER}* Date: ${DATE}* Time: ${TIME} ${PARAM_DOC} #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end ${THROWS_DOC} */
1、phpstorm中如何给方法函数添加注释?
在方法前面,输入 /**后回车
2、方法(函数)注释样例?
/*** Notes:* User: ${USER}* Date: ${DATE}* Time: ${TIME} ${PARAM_DOC} #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end ${THROWS_DOC} */
应用这样样例得到的注释结果:
/*** Notes:* User: rfan* Date: 2018-11-04* Time: 7:13 AM* @param $param1* @param $param2* @param $param3* @return \think\response\View|void* @throws \think\db\exception\DataNotFoundException* @throws \think\db\exception\ModelNotFoundException* @throws \think\exception\DbException*/
3、我们想设置各种模板样例在哪里设置,比如html文件的默认代码,比如类、方法等的注释?
setting editor templates
File->Setting->Editor->File and Code Templates
二、PhpStorm函数注释的设置
首先,PhpStorm中文件、类、函数等注释的设置在:setting-》Editor-》FIle and Code Template-》Includes下设置即可,其中方法的默认是这样的:
/** ${PARAM_DOC} #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end ${THROWS_DOC} */
但是我发现,文件中的默认注释是这样的:
1 /** 2 * Created by ${PRODUCT_NAME}. 3 * User: ${USER} 4 * Date: ${DATE} 5 * Time: ${TIME} 6 */
当我把上面这段中3、4、5行的代码直接复制放到PHP Function Doc Comment这个下面的时候,发现其中占位符{}中的东西并没有被替换,而是当成字符串打出来了。
方法:
1、我们在PhpStorm中setting-》Editor-》Live Template,即找到模板选项,会看到各种语言的模板设置;
2、找到右边有个+号,创建一个自定义模板:选择Live Template,然后按照下图的配置顺序进行设置:
3、点保存之后,回到FIle and Code Template-》Includes,在PHP Function Doc Comment这里设置:
/*** Notes:* User: ${USER}* Date: ${DATE}* Time: ${TIME} ${PARAM_DOC} #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end ${THROWS_DOC} */
4、点击Apply,点击OK,然后在方法前面,输入 /**后回车:
/*** Notes:下单接口* User: Steven* Date: 2017/12/28* Time: 15:19* @return array* @throws \yii\db\Exception*/
OK,完成。
https://www.cnblogs.com/Steven-shi/p/8136081.html
转载于:https://www.cnblogs.com/Renyi-Fan/p/9903022.html
PhpStorm函数注释的设置相关推荐
- PHPstorm 函数或者方法的注释的时间和用户名,PHPstorm里函数方法的注释是没有动态时间设置的,但是看了PHP file里面有时间日期的注释,而PHP Function Doc Commen
PHPstorm 函数或者方法的注释的时间和用户名,PHPstorm里函数方法的注释是没有动态时间设置的,但是看了PHP file里面有时间日期的注释,而PHP Function Doc Commen ...
- PHPstorm 函数时间注释的修改 正常的PHPstorm里面函数方法的注释是没有动态时间设置的,但是看了PHP file里面有时间日期的注释,而PHP Function Doc Commen
PHPstorm 函数时间注释的修改 正常的PHPstorm里面函数方法的注释是没有动态时间设置的,但是看了PHP file里面有时间日期的注释,而PHP Function Doc Comment 却 ...
- Android Studio查找或设置函数注释的快捷键
启动Android Studio打开样例工程,如图: 打开Settings对话框,执行"File"-"Settings",如图: 在左侧选择"Keym ...
- vsCode设置文件注释和函数注释使用koroFileHeader插件
1.安装koroFileHeader插件 2.配置内置文件 找到配置文件 找到settings.json文件 在settings.json中添加如下配置(如果重复的替换即可) //文件注释" ...
- phpstrom函数注释模板_PHPstorm 函数时间注释的修改
正常的PHPstorm里面函数方法的注释是没有动态时间设置的,但是看了PHP file里面有时间日期的注释,而PHP Function Doc Comment 却没有,让很多PHPer很头疼,今天在搜 ...
- vim插件的安装方式 -- vim注释插件和doxygen函数注释生成插件-ctrlp插件-tabular等号对齐 插件...
使用unzip的时候 指定 -d选项, 是说明解压到的 目标地址. 这个参数还是比较方便的, 比直接unzip到当前目录, 然后在去拷贝到目标目录, 然后再删除当前目录中的解压文件夹, 方便多了. 使 ...
- 8 pycharm 快捷键_Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释 文件头模板设置路径 Set ...
- Android Studio新建类头部注释和添加函数注释模板及快捷键
一,Android Studio新建类头部注释 是不是有时候看到这个很心烦 其实Studio中有设置修改这些注释模板的信息的功能 其实很简单,只需要两步: 1.打开Setting设置面板,找到File ...
- Runtime底层原理--Runtime简介、函数注释
Runtime官方文档介绍直通车 扩展:编译时 看到运行时就会想到编译时,编译时主要是将源代码翻译成可识别的机器语言,如果编译时类型检查等翻译过程中发现语法分析之类有错误会给出相应的提示.比如OC,s ...
最新文章
- 2021-07-08执行Linux的命令分析
- javascript——事件默认行为
- 一个线程中lock用法的经典实例
- Spring Boot (1) 构建第一个Spring Boot工程
- face-recognition库(人脸识别库)安装,使用
- 苹果台式机_苹果史上最强台式机来了:顶配售价45万
- 计算机用户权限设置不了,电脑中怎样设置everyone权限
- [ZJOI 2012]灾难
- Linux基础操作及命令管理
- 将矩阵转为一行_理解矩阵乘法
- 记录QT在实时显示摄像头数据时候切换TAB页出现异常
- 人工智能、区块链、算法...这30个大数据热词你知道吗?
- UVA 10791 Minimum Sum LCM 数论
- C# 之 LINQ(一)
- order by排序的用法
- 【JS】V8 引擎原理
- spring boot项目:用户中心的商品信息编辑功能
- Android能够获取到唯一的设备ID吗?
- 记php cmsv9采集管理,采集图片地址协议为https不能下载的问题
- jQuery 自制上传头像插件-附带Demo实例(ajaxfileupload.js第三弹)