idea注释模板

Posted 2020-11-26 dshvv

进入配置项

File>Setting>Live Templates

新建（注释）模板组

点击右侧的+号，选择Template Group
名字随意，如：myTemp

新建（注释）模板

选中myTemp组，再次点击右侧的+号。选择live Template

创建类的（注释）模板

abbreviation处填写class
template text处填写如下代码(author改为自己的名字)：

/**
 * xxx类
 * @author 丁少华
 * @date $date$ $time$
 */

$xxx$是变量xxx的意思，需要对其配置，点击右侧的 varibles按钮对其配置
date的Express配置为date()
time的Express配置为time()
点击template text下方的提示，No applicable context. Define，下拉选择javascript and Typescript

创建vue组件（注释）模板

vue组件也是一个类，跟上边类注释差不多，只不过需要标明继承至vue
abbreviation处填写vc（vue compnebts的简写）
template text处填写如下代码(author改为自己的名字)：

/**
 * xxx组件
 * @author 丁少华
 * @date $date$ $time$
 * @extends Vue
 */

创建方法的（注释）模板

abbreviation处填写fn
template text处填写如下代码：

 /**
  * 用于xxx
  * @param {string} uid - 用户id
  * @return {User}一个用户
  */

创建属性的（注释）模板

属性就不用模板了。单行注释就行，说清楚这个属性用于做什么

其他

@throws：如果类或者方法可能抛出异常，要用此标签
@module: 到处模块请看此处

使用方法

输入刚才定义的abbreviation，按下tab，即可。

jsDoc文档

利用jsDoc规范来注释代码，能快速生成对应的文档
jsDoc使用方法和说名，参考此处

如果你使用的工具是vscode

那么只需要按下ctrl+shfit+p，输入snippets。
创建或者找到javascript.json或typescript.json，回车，进入其配置文件编辑界面。
在文件输入类似以下内容即可：

{
  "Print to js class": {
    "prefix": "vc",
    "body": [
        "/*",
        " *@description: $0",
        " *@author:  丁少华",
        " *@date: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
        " */"
    ]
  }
}

使用跟idea一样