1.设置用户信息

1.1 Android Studio修改注释模板中的${USER}变量：

  • 进入 Android Studio 的安装目录，进入bin下面。
  • 找到 studio64.exe.vmoptions 和 studio.exe.vmoptions。
  • 在最后一行添加一行 -Duser.name=xxx
  • 重启AndroidStudio。

1.2 修改默认的头部注释：

  • File->Settings->Editor->File and Code Templates->Includes->File Header

  • 填写模板：

1
2
3
4
/**
 * Created by ${USER} on ${DATE} at ${TIME}
 * Describer:
 */

1.3 通过快捷指令 插入头部注释：

  • File–Settings–Editor–Live Template
  • 点击右侧+，添加一个Templates Group
  • 自定义Name， 如：York
  • 选中York组，再次点击右侧+，向组中添加一个Template。
  • 在Abbreviation 填入名称，如： desc。
  • 在Description 填入描述，如：添加注释信息。
  • 此时Template 显示为：desc（添加注释信息）。
  • 添加Template text
1
2
3
4
/**
 * Created by $USER$ on $DATE$ at $TIME$
 * Describer:
 */
  • 其中USER、DATE等双美元符号注释的类型为自定义类型，可通过点击Edit variables 进行定义。
  • 勾选Applicable的文件类型，基本可以全选。
  • 在任意文件中，输入desc，测试是否可以生产注释信息代码片段。如下：
1
2
3
4
/**
 * Created by York on 2023/4/10 at 0:40
 * Describer:
 */

2. AndroidStudio中使用markdown插件

Android Studio 中双击readMe.md文件，看到的是原始文件内容，不便于阅读。

可通过安装markdown插件浏览md文件的内容。此插件不但支持md 文件的预览，也支持实时动态编辑，简单好用。

  • 在Android Studio中 File– settings–plugins 中安装markdown 插件。
  • 但一般还是不能预览。还需要配置Boot Runtime。如下：
  • 在AndroidStudio中双击shift按钮，在弹窗中选中Actions，然后在输入框中输入Choose Boot Runtime for the IDE，回车后在弹窗中点击下拉列表，选中一个与Android studio匹配的版本自动安装。
  • 重启AndroidStudio使插件生效。

3. 设置编码风格

遵守Google Kotlin样式指南，项目中接入Spotless插件并配置为ktmft google style

请安装 ktfmt IntelliJ plugin 插件在启用后设置Code style为Google (internal), 确保idea快捷键格式化与插件格式化风格相同。