使用Android Studio设置类注释以及方法注释

前言

最近在看阿里的java代码规范中写到, 所有的类都必须添加创建者信息, 就熟悉了一下如何添加类的注释信息, 顺便也了解了方法注释的步骤。两种注释设置的详细步骤如下。

类注释

类注释的设置相比来说较为简单, 首先使用快捷键 ctrl+alt+s 弹出 Settings 对话框，选择 Editor 里面的 File and Code Templates, 在 Includes 里面选择 File Header 选项:

在右侧的编辑框里面即可自定义自己想要呈现的注释内容, 此处我只填写了作者和日期:

/**
  *
  * @author: ${USER}
  * @date: ${DATE}
  */

这样设置之后, 每次新建类时便会自动显示作者和当前日期, 当然此处也可以添加其他内容。

方法注释

要想设置方法注释，首先也是使用快捷键 ctrl+alt+s, 进入 Editor, 此处选择 Live Templates 选项:

在弹出的选项框中点 + 选择 Template Group 新建 Template Group 为 CustomTemplate (可以任意取):

点击 ok 可以看到列表中新增了一项 CustomTemplate, 选中此项, 点击 + 选择 Live Template:

设置 Abbreviation 为 cmt, 这个为注释的快捷键, 当在方法的上方输入 cmd 时, 即可出现注释。当然也可以任意设置为其他字符。随后编辑在 Template Text 中的注释模板:

此处我的设置如下, 包括方法描述 description 参数 param 返回值类型 return 作者 author 时间time:

/**
  *
  * @description $desc$
  * @param $methodParameters$
  * @return $methodReturnType$
  * @author $user$
  * @time $date$ $time$
  */

随后点击 Change 选择 Declaration 将其设置为注释时显示。

点击 Edit variables, 开始设置每个名称的作用, 如将 name 为 user 的表达式设置为 user(), 即可自动显示作者名, date() 自动显示最新日期：

点击 ok apply 即可。 在 java 文件中的方法上输入 cmt 即可出现设置模板, 如下: