浅谈idea live template高级知识_进阶(给方法,类,js方法添加注释)

IDEA中的Live Templates是一个非常方便的功能，可以帮助我们快速地插入常用的代码格式。本文将介绍如何使用Live Templates为方法、类和JS方法添加注释。

为方法添加注释

步骤1：打开Live Templates设置

首先，要打开IDEA的Live Templates设置。这可以通过按下“Ctrl+Alt+S”来打开设置窗口，在左侧导航栏中选择“Editor -> Live Templates”。

步骤2：创建一个新的Live Template

在打开的窗口中，选择适当的组（例如“Java”），然后单击“添加”按钮。在弹出的菜单中选择“Live Template”。

步骤3：填写Live Template信息

在新窗口中，填写Live Template的信息：

• Abbreviation：设置Live Template的简称，例如“metdoc”。
• Description：描述Live Template的作用和用法。
• Template text：这是Live Template的主要内容。以下是一个示例：

/**
 * $description$
 *
 * @param $parameter$ $parameter_description$
 * @return $return_description$
 */
public $return_type$ $method_name$($parameter_type$ $parameter$) {
  $END$
}

在这个示例中，我们使用了一些变量，例如“$description$”、“$parameter$”和“$return_type$”。在实际使用时，这些变量会被替换为实际的值（例如方法的描述、参数名和返回类型）。

步骤4：保存Live Template

保存Live Template后，我们就可以使用它了。只需要在方法的声明处使用“metdoc”（或者其他Live Template的简称），并按下Tab键即可插入注释。

public void addUser(String name, int age) {
  // 这里插入了上面设置的方法注释
  $END$
}

为类添加注释

步骤1：创建一个新的Live Template

创建一个新的Live Template，选择适当的组（例如“Java”），然后单击“添加”按钮。在弹出的菜单中选择“Live Template”。

步骤2：填写Live Template信息

在新窗口中，填写Live Template的信息：

• Abbreviation：设置Live Template的简称，例如“cladoc”。
• Description：描述Live Template的作用和用法。
• Template text：这是Live Template的主要内容。以下是一个示例：

/**
 * $description$
 *
$email$
 * $date$
 */
public class $class_name$ $uper_class$ {
  $END$
}

在这个示例中，我们使用了一些变量，例如“$description$”、“$email$”和“$date$”。在实际使用时，这些变量会被替换为实际的值（例如类的描述、作者的电子邮件地址和日期）。

步骤3：保存Live Template

保存Live Template后，我们可以在类的声明处使用“cladoc”（或者其他Live Template的简称），并按下Tab键即可插入注释。

/**
 * This is the description for the SampleClass.
 *
 [e-mail]
 * 2022-04-10
 */
public class SampleClass {
  $END$
}

为JS方法添加注释

步骤1：创建一个新的Live Template

创建一个新的Live Template，选择适当的组（例如“JavaScript”），然后单击“添加”按钮。在弹出的菜单中选择“Live Template”。

步骤2：填写Live Template信息

在新窗口中，填写Live Template的信息：

• Abbreviation：设置Live Template的简称，例如“jsdoc”。
• Description：描述Live Template的作用和用法。
• Template text：这是Live Template的主要内容。以下是一个示例：

/**
 * $description$
 *
 * @param $parameter$ $parameter_description$
 * @return $return_description$
 */
function $function_name$($parameter$) {
  $END$
}

在这个示例中，我们使用了一些变量，例如“$description$”、“$parameter$”和“$return_description$”。在实际使用时，这些变量会被替换为实际的值（例如方法的描述、参数名和返回类型）。

步骤3：保存Live Template

保存Live Template后，我们就可以在JS方法的声明处使用“jsdoc”（或者其他Live Template的简称），并按下Tab键即可插入注释。

function add(x, y) {
  // 这里插入了上面设置的方法注释
  $END$
}

通过上述示例，我们可以快速的为方法、类和JS方法添加注释，大大提高了我们的编码效率。