Android Studio 配置系列(一):自定义代码注释

  1. 自定义文件头注释

依次点击File -> Settings ->Editor ->File and Code Templates,在详细展示窗口点击includes选项卡,找到FileHeader点击,在编辑窗口输入自定义的注释模板即可。

示例:
/*

 * -----------------------------------------------------------------

 * Copyright (C) 2014-2016, by your company, All rights reserved.

 * -----------------------------------------------------------------

 *

 * File: ${NAME}.java

 * Author: ${USER}

 * Version: V100R001C01

 * Create: ${DATE} ${TIME}

 *

 * Changes (from ${DATE})

 * -----------------------------------------------------------------

 * ${DATE} : Create ${NAME}.java (${USER});

 * -----------------------------------------------------------------

 */

通常我们可以使用如下的通配符:

${PACKAGE_NAME}         新建文件所在包名

${USER}             当前系统登录的用户名

${DATE}             创建文件时当前系统的日期(格式:yyyy/MM/dd)

${TIME}             创建文件时当前系统的时间(格式:hh:mm)

${YEAR}             创建文件时当前系统的年份

${MONTH}                创建文件时当前系统的月份
 
${MONTH_NAME_SHORT} 当前月份的前三位字符缩写,例如: Jan, Feb, etc.

${MONTH_NAME_FULL}      当前月份的字母全写,例如: January, February, etc.

${DAY}                  当前时间所属月份的天数

${HOUR}             当前的小时数

${MINUTE}               当前的分钟数

${PROJECT_NAME}     当前的项目名

${NAME}             当前的文件名

做完这些点击ok即可。

  1. 添加代码块自定义注释模板

  • 依次点击File -> Settings ->Editor ->Live Templates

  • 在详细展示窗口右侧点击


  • 键入组名字



    ,输入完成后点击ok

  • 在详细展示列表找到刚刚保存的那个组并选中

  • 在详细展示窗口右侧点击


  • 在abbreviation处输入缩写,使用时候需要用到此缩写,description处输入模板描述
  • Template text处输入注释模板
/**
 - @Description:  $desc$
 - @Author:  $user$
 - @Time:  $date$ $time$
 */
  • 点击Edit variables,进行如下编辑
  • 点击详细展示窗口下方的change按钮,选择注释模板的使用范围,此处我们选择java declaration即可。
  • 做完这些保存即可。

  • 使用方法:在代码中需要添加注释的地方输入刚刚的缩写字母,就会有提示了,

按下enter后就会自动填写了注释模板


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,993评论 19 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,597评论 25 708
  • 转自https://juejin.im/post/59c879a3f265da064703fbff Android...
    姑娘请别为难小僧阅读 4,695评论 0 4
  • “我希望我满头白发的时候,依然能看到你们,当我们都老了的时候。” “南方没有暖气有什么关系,不是有你们么。” “基...
    小胖手阅读 409评论 0 1
  • 鹅毛大雪,漫天阴沉。整个容芷园弥漫着浓浓的伤情。 白洛漓静静的坐在这屋子里,升起的炉火与外面的大雪相映衬。她手中拿...
    RMM慢慢走阅读 421评论 0 0