IDEA添加注释

添加类说明

File and Code Templates --> Class Interface Enum

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* @author ${USER}
* @date ${DATE}
* @description
* @exception
* @see
*/
public enum ${NAME} {
}

添加方法说明

Live Templates --> + --> Template group --> Live Templates

/**
* @author $author$
* @date  $DATE$ $TIME$
* @description
* @version
* @since
* @see
*/

Edit variables:
author user()
DATE date()
TIME time()

注释说明:

@description 注释后⾯面主要供填写类或方法的作⽤功能等。
@exception 主要是特殊异常的一些提醒,提醒代码编写人员注意此类异常。常规异常不用写,此处可空。
@version 只会标记在方法上,记录方法的当前版本,跟随这个工程的大版本变化,供开发⼈人员查阅。
@since 记录方法出现的最初版本,和@version一起提供一些修改信息供开发人员迅速查阅。
@see 主要是列出一些与此类关系密切的类,可直接点击查阅

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

推荐阅读更多精彩内容

  • 1.为类添加注释 File-->Settings-->Editor-->File and Code Templat...
    王侦阅读 1,140评论 0 0
  • 为类添加自动注释模版 File-->Settings-->Editor-->File and Code Templ...
    哎呦撞衫啦阅读 223评论 0 0
  • pyspark.sql模块 模块上下文 Spark SQL和DataFrames的重要类: pyspark.sql...
    mpro阅读 9,537评论 0 13
  • 一、编程规约 (一)命名规约 【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反...
    喝咖啡的蚂蚁阅读 1,553评论 0 2
  • 八月的一天,傍晚时分,钩湖在晚霞地辉映下,犹如水彩画似得金黄一片,波光粼粼的,像一条黄金大道。从湖的这一端一直通到...
    赵赵的时光映像阅读 265评论 0 0