精华内容
下载资源
问答
  • JAVA类和方法的注释自定义自动生成(IDEA) 具体内容大家看链接里面的信息吧都挺全的,我就提供两个我自己用的模版好了。 一、IDEA中设置类注释 1、路径:File——>settings——>Editor——>File and Code ...

    JAVA类和方法的注释自定义自动生成(IDEA)

    自动生成类和方法的模版能够方便别人阅读你的代码,也能让之后的自己更好的的回想起代码的意思。

    一、IDEA中设置类注释

    1、路径:File——>settings——>Editor——>File and Code Templates——>Files——>Class(能设置类的注释自然也能设置接口的,要设置接口注释选择Interface即可)
    在这里插入图片描述

    1、类的模版

    (1) @ClassName:设置类名,${NAME}能获取到创建的类名

    (2)@Description:写有关于类的描述

    ①TODO:代办事项的标记,一般生成类或方法都需要添加描述
    ②${description}:能让你在创建类的时候再次弹出一个输入框,输入这个类的描
    述,能让你不用再建好类之后再去写描述,会方便一些
    

    (3)@Author :输入写当前这个类的作者的名字,你可以在这里默认添加你的名字

    (4)@Create设置创建类的日期和时间

    ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:是输出日期的格式
    

    (5)@Version;设置版本号

    1.0:一般新创建的类都是1.0版本,这里直接写他也可以
    
    /**
    * @ClassName: ${NAME}
    *
    * @Description: TODO ${description}
    *
    * @Author: 作者的名字
    *
    * @Create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
    *
    * @Version 1.0
    **/
    

    2、类模版的显示效果

    在这里插入图片描述

    二、IDEA中设置方法注释

    1、路径:File——>settings——>Editor——>Live Templates——>点击右边加号为自己添加一个Templates Group (我的命名为Test)
    (1)点击右边加号为自己添加一个Live Template,给自己的模版命名,IDEA生成注释的默认方式是:/*+模板名+快捷键图中将快捷键改成了Enter,那么方法生成的方式为:

    /*+Enter或 /***+Enter
    

    在这里插入图片描述

    1、方法的模版

    我是定义了两个方法的模版的*对应的是没有返回值的方法,**对应的是有返回值的方法

    (1)注意第一行,只有一个*而不是 /*

    在设置参数名时必须用\${参数名}$的方式,否则在Enter veriables中读取不到你设置的参数名
    

    (2)@Description:写有关于方法的描述

    $description$ :设置的方法描述的变量名
    

    (3)@Param:写方法的参数

    $params$ :设置的参数的变量名
    

    (4)@return:写方法的返回值

    $returns$ :设置的返回值变量名
    

    (5)@Author :输入写当前这个类的作者的名字,你可以在这里默认添加你的名字
    (6)@Create设置创建类的日期和时间

    $date$ $time$:设置的天数和时间的变量名
    

    (7)需要设置模版的应用场景也就是它的作用域

    点击模板页面最下方的define,来设置将模板应用于那些场景,全选即可,要
    是真要划分到java这一块就选择EveryWhere——>Java
    (修改过后下面的define就变成了change)
    

    (8)设置参数的获取方式(必须先完成上方的设置才可以获取到参数),点击Enter veriables,按照我的截图,在下拉框里面选择设置即可
    在这里插入图片描述

    *
    * 
    * @Description: $description$ 
    * @Param: $params$ 
    * @Author: 作者的名字
    * @Date: $date$ $time$
    */ 
    
    **
    * 
    * @Description: $description$ 
    * @Param: $params$ 
    * @return: $returns$ 
    * @Author: 作者的名字
    * @Date: $date$ $time$
    */ 
    

    2、方法模版的显示效果

    创建方法,在方法上面写:/*+模板名+Enter或者/**+Enter即可

    *

    在这里插入图片描述

    **

    在这里插入图片描述

    展开全文
  • 在使用Eclipse 编写Java代码时,自动生成注释信息都是按照预先设置好的格式生成的。修改作者、日期注释格式:打开Windows->Preferences->Java->Code Style->Code Templates,点击右边窗口中的Comments...

    在使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式生成的。

    修改作者、日期注释格式:打开Windows->Preferences->Java->Code Style->Code Templates,点击右边窗口中的Comments,可以看到有很多选项,我们便可对此注释信息模板进行编辑。

    如我们希望在一个Java文件的开头设置作者信息、日期信息。

    选择Types,点击Edit,将

    /**

    * @author ${user}

    * ${tags}

    */

    将${user}删除,改成你希望显示的名字;将${tags}删除,点击Insert Variable,选择Date,这样就会自动生成日期信息。在你需要添加注释的地方点击Sources->Ganarate Element Comment,或者使用快捷键 Alt+Shift+J ,则 eclipse 自动在该类前面添加注释。

    注释的规范如下:

    文件注释标签:

    /**

    *

    Title: ${file_name}

    *

    Description:

    *

    Copyright: Copyright (c) 2007

    *

    Company: LTGames

    * @author linrz

    * @date ${date}

    * @version 1.0

    */

    类型注释标签(类的注释):

    /**

    *

    Title: ${type_name}

    *

    Description:

    *

    Company: LTGames

    * @author linrz

    * @date ${date}

    */

    字段注释标签:

    /** ${field}*/

    构造函数标签:

    /**

    *

    Title:

    *

    Description:

    * ${tags}

    */

    方法标签:

    /**

    *

    Title: ${enclosing_method}

    *

    Description:

    * ${tags}

    */

    覆盖方法标签:

    /* (非 Javadoc)

    *

    Title: ${enclosing_method}

    *

    Description:

    * ${tags}

    * ${see_to_overridden}

    */

    代表方法标签:

    /**

    * ${tags}

    * ${see_to_target}

    */

    getter方法标签:

    /**

    * @return ${bare_field_name}

    */

    setter方法标签:

    /**

    * @param ${param} 要设置的 ${bare_field_name}

    */

    环境说明:

    WindowsXP sp3

    Eclipse3.6 Helios Release

    一、.java 文件部分

    ---------------------

    eclipse-->windows-->preferences-->Java-->Code Style-->Code Templates-->Code-->New Java files-->单击[edit]按钮

    在文件首行,添加如下内容:

    Java代码

    ${filecomment}

    ${package_declaration}

    /**

    * 创建时间:${date} ${time}

    * 项目名称:${project_name}

    * @author daniel

    * @version 1.0

    * @since JDK 1.6.0_21

    * 文件名称:${file_name}

    * 类说明:

    */

    ${typecomment}

    ${type_declaration}

    ${filecomment}

    ${package_declaration}

    /**

    * 创建时间:${date} ${time}

    * 项目名称:${project_name}

    * @author daniel

    * @version 1.0

    * @since JDK 1.6.0_21

    * 文件名称:${file_name}

    * 类说明:

    */

    ${typecomment}

    ${type_declaration}

    或者

    Java代码

    ${filecomment}

    ${package_declaration}

    /**

    * Filename: ${file_name}

    * Copyright: Copyright (c)2010

    * Company: com

    * @version: 1.0

    * @since: JDK 1.6.0_21

    * Create at: ${date} ${time}

    * Description:

    *

    * Modification History:

    * Date Author Version Description

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

    * ${date} daniel 1.0 1.0 Version

    */

    ${typecomment}

    ${type_declaration}

    ${filecomment}

    ${package_declaration}

    /**

    * Filename: ${file_name}

    * Copyright: Copyright (c)2010

    * Company: com

    * @version: 1.0

    * @since: JDK 1.6.0_21

    * Create at: ${date} ${time}

    * Description:

    *

    * Modification History:

    * Date Author Version Description

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

    * ${date} daniel 1.0 1.0 Version

    */

    ${typecomment}

    ${type_declaration}

    二、.jsp 文件部分

    ---------------------

    eclipse-->windows-->preferences-->Web-->JSP Files-->Editer-->Templates-->New JSP File-->单击[edit]按钮

    在文件首行,添加如下内容:

    Java代码

    创建时间:${date}${time}

    创 建 人:daniel

    相关说明:

    JDK1.6.0_21 tomcat6.0.29 servlet2.5

    --%>

    创建时间:${date}${time}

    创 建 人:daniel

    相关说明:

    JDK1.6.0_21 tomcat6.0.29 servlet2.5

    --%>

    这样再创建 .java 或 .jsp 文件时,eclipse 就会为我们自动将注释写好。你还可以通过“导出”、“导入”功能,把自己的模板导出来,方便在其他机器上使用。

    From:http://blog.sina.com.cn/s/blog_4080505a0101guoh.html

    展开全文
  • 可恢复(IDEA)创建Java类时,自动生成作者...看老师上课时生成注释特别方便,特意去问了一下,以下是成品。 1、作者、时间和版本号注释 1、File->settings… 2、Editor->File and Code Templates->Includes-

    (IDEA)创建Java类时,自动生成作者、时间和版本号注释;以及方法注释时,自动生成参数和返回值注释

    看老师上课时生成注释特别方便,特意去问了一下,以下是成品。
    在这里插入图片描述

    1、作者、时间和版本号注释

    1、File->settings…
    在这里插入图片描述2、Editor->File and Code Templates->Includes->File Header(双击),然后在右边输入框内输入代码即可
    在这里插入图片描述
    /**

    • @Author 作者名 -----------------(自己设置)
    • @Date ${DATE} ${TIME}------(时间)
    • @version 1.0---------------------(版本号)
    • @注释--------------------------(类的注释)
      */
      下边代码可直接复制
    /**
     * @Author 作者名
     * @Date ${DATE} ${TIME}
     * @version 1.0
     * @注释
     */
    

    最后点击Apply即可。

    2、方法注释:自动生成方法中参数和返回值

    1、仍然是File->settings…->Editor
    2、这此选择Live Templates
    3、点击右边“+”号
    4、选择2.template group,然后在弹出来的输入框内输入名字methodNots(可自己定义)

    在这里插入图片描述
    5、然后,选中刚才创建的methodNots,然后再次点击右侧的绿色+,这次选择的是第一个1. Live Template。取名为method(亦可自己定义),之后看图片。
    在这里插入图片描述6、看图片,在7内输入

    *
     * 
     * $VAR1$ 
     $params$* @return $returns$
     * @author yuxin
     * @creed: Talk is cheap,show me the code
     * @date $date$ $time$
     */
    
    

    点击Edit variables进行配置,然后点击VAR1的第二个框(看图),输入

        groovyScript("
        	def result='';  
        	def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();   
        	for(i = 0; i < params.size(); i++) {   	
        		if(i!=0)result+= ' * ';    	
        		result+='@param ' + params[i] + ((i < (params.size() - 1)) ? '\\n' : '');   
        	};    
        	return result", methodParameters())
    
    

    最后一步,在方法前输入/**然后按回车即可生成,示例如第一张图
    在这里插入图片描述

    参考文章:
    https://blog.csdn.net/yuruixin_china/article/details/80933835

    展开全文
  • 一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常...本节将简单地介绍、方...

    一个程序的可读性,关键取决于注释。如果一个程序想二次开发,要读懂前面的程序代码,就必须在程序中有大量的注释文档,所以对于一个优秀的程序员来说,学会在程序中适当地添加注释是非常重要的。

    注释除了帮助别人了解编写的程序之外,还对程序的调试、校对等有相当大的帮助。当程序具体运行时,计算机会自动忽略注释符号之后所有的内容。教程第二章中曾经提到过注释,读者也许印象不太深,在这里复习一遍。

    本节将简单地介绍类、方法、字段等地方的注释方法,这些地方的注释虽然简单但是在开发工作中却是非常重要的。

    注意:本节注释使用文档注释。多行注释的内容不能用于生成一个开发者文档(文档提供类、方法和变量的解释,也可称为帮助文档),而文档注释可以。

    1. 类注释

    类注释一般必须放在所有的“import”语句之后,类定义之前,主要声明该类可以做什么,以及创建者、创建日期、版本和包名等一些信息。以下是一个类注释的模板。

    /**

    * @projectName(项目名称): project_name

    * @package(包): package_name.file_name

    * @className(类名称): type_name

    * @description(类描述): 一句话描述该类的功能

    * @author(创建人): user

    * @createDate(创建时间): datetime

    * @updateUser(修改人): user

    * @updateDate(修改时间): datetime

    * @updateRemark(修改备注): 说明本次修改内容

    * @version(版本): v1.0

    */

    提示:以上以@开头的标签为 Javadoc 标记,由@和标记类型组成,缺一不可。@和标记类型之间有时可以用空格符分隔,但是不推荐用空格符分隔,这样容易出错。

    一个类注释的创建人、创建时间和描述是不可缺少的。下面是一个类注释的例子。

    /**

    * @author: zhangsan

    * @createDate: 2018/10/28

    * @description: this is the student class.

    */

    public class student{

    .................

    }

    注意:没有必要在每一行的开始用*。例如,以下注释同样是合法的:

    /**

    @author: zhangsan

    @createDate: 2018/10/28

    @description: this is the student class.

    */

    public class student{

    .................

    }

    2. 方法注释

    方法注释必须紧靠在方法定义的前面,主要声明方法参数、返回值、异常等信息。除了可以使用通用标签外,还可以使用下列的以@开始的标签。

    @param 变量描述:对当前方法的参数部分添加一个说明,可以占据多行。一个方法的所有 @param 标记必须放在一起。

    @return 返回类型描述:对当前方法添加返回值部分,可以跨越多行。

    @throws 异常类描述:表示这个方法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。

    下面是一个方法注释的例子。

    /**

    * @param num1: 加数1

    * @param num2: 加数2

    * @return: 两个加数的和

    */

    public int add(int num1,int num2) {

    int value = num1 + num2;

    return value;

    }

    以上代码的 add() 方法中声明了两个形参,并将它们两个的和作为返回值返回。

    为类的构造方法添加注释时,一般声明该方法的参数信息,代码如下。

    public class Student {

    String name;

    int age;

    /**

    * @description: 构造方法

    * @param name: 学生姓名

    * @param age: 学生年龄

    */

    public Student(String name,int age) {

    this.name = name;

    this.age = age;

    }

    }

    3. 字段注释

    字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。

    /**

    * 用户名

    */

    public String name;

    也可以使用如下格式:

    /**用户名*/

    public String name;

    在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望读者不要忽视它。

    展开全文
  • 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。在Javadoc Generation对话框中有两个地方要注意的:javadoc command:应该选择jdk的bin/javadoc....
  • 在使用Eclipse 编写Java代码时,自动生成注释信息都是按照预先设置好的格式生成的。修改作者、日期注释格式:打开Windows->Preferences->Java->Code Style->Code Templates,点击右边窗口中的Comments...
  • 自动生成Java类注释

    2021-07-13 10:10:21
    使用LiveTemplate生成Java类注释 添加template组 配置使用场景 点击Define选择Java 配置模板 ** * @author baocheng.qin * @version V1.0 * @Package $PACKAGE_NAME$ * @Description: $NAME$ * @date $...
  • IntelliJ IDEA新建时,自动设置注释作者信息和日期时间 1.简约风 设置步骤: File–> Settings–> Editor–> File and Code Templates–> Includes–> File Header–> 添加如下代码(此处的${...
  • 1,java如何生成doc文档。用eclipse内置的功能,右键项目-->export-->java-->javadoc-->javadoc command 选择jdk的bin目录的javadoc.exe,destination选择输入目录,点击finish即可。2,注释注意事项...
  • 1. 生成类注释打开Preferences-->Editor-->File and Code Templates,右侧选择Filestab页,找到Class、Interface,可以看到右侧模板里引用了一个File Header.java模板,如下图:模板变量说明${PACKAGE_NAME} ...
  • MOXy BeanValidation使我能够为我的JAXB添加验证.使用MOXy的“Bean Validation Plugin”我可以在...但是有没有办法使用restrictions/facets基于来自JAXB注释Java类的Bean Validation注释生成模式?XJC在执行’sc...
  • * @version java1.8 */ public class demo1 { /** * 该的无参构造方法 */ public demo1() { } /** *获取两数之和 * @param a 加数 * @param b 被加数 * @return 经过if语句判断后返回的String值
  • javadoc生成注释文档

    2021-03-12 20:44:59
    它采用java编译器的某些技术,查找程序内的特殊注释标签。它不仅解析由这些标签标记的信息,也将毗邻注释的类名或方法抽取出来。javadoc生成的是一个html文件。二、语法所有javadoc命令都只能在"/**"注释中出现,...
  • Java的文档注释生成帮助文档的实例示例:/*** Title: Person* Description:通过Person说明Java中的文档注释* Company: **** @author **** @version 1.0*/public class Person {/*** 这个是Person的构造方法*...
  • Java注释的完整介绍

    2021-03-05 15:06:03
    Java中的注释是一种特殊的Java构造,用于修饰源代码中使用的元素的语法元数据,为Java解释器在代码翻译过程中提供特殊的信息指导,我们将讨论以下概念。Java中的注释是什么?为什么我们需要注释Java中的注释是一...
  • Java 类注释文档编写方法对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序——人们也需要考虑程序的文档化问题。对于程序的文档化,最大的问题莫过于对文档的维护。若文档与代码分离,那么...
  • 这篇文章主要介绍了idea创建JAVA Class时自动生成头部文档注释的方法,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下. IDEA设置文档注释模板 创建...
  • Java 标准注释

    2021-03-13 01:09:52
    Java面向对象设计 - Java标准注释Java API定义了许多标准注释类型。以下部分讨论了在java.lang包中定义的四种最常用的标准注释。DeprecatedOverrideSuppressWarningsFunctionalInterface已弃用的注释类型弃用的注释...
  • 这是一个有文档注释/** */的java代码: notepad++中鼠标右键—》选择 “打开所在文件夹(命令行)” —》cmd中已经进入改文件所在目录,输入命令“javadoc -d myFirstJava -author -version HelloWorld3.java” ...
  • protobuf生成java工具

    2021-03-10 06:06:25
    由于本人最近在学习Netty,里面涉及了protobuf编译生成java文件的过程,觉得敲命令行比较麻烦,故写了个.prorto文件自动生成java文件的工具,遇到了不少坑,与大家分享一下,望多多指正。转载请注明出处:...
  • Java 将数据库对应的表生成对应的实体,包含注释信息 小工具使用不同的数据需要对应数据库驱动jar包,请自行添加/****/package com.cloud.utils.temp;import java.io.File;import java.io.FileWriter;import java....
  • idea设置Java类和方法注释模板
  • 首先打开idea设置 file->settings,如下图。 想要什么样的配置直接在设置中添加代码即可 .../** * @Author ${USER} * @Description TODO * @Date ${DATE} ${TIME} * @Version 1.0 ... * Created by ${USER} on ${...
  • Java中的注释

    2021-02-12 09:32:09
    /***/(1)@author 开发这个模块的作者(2)@version 版本(3)@see 参考转向 相关主题(4)@param 参数(5)@return 返回值(6)@Exception 异常生成文档注释的用法: javadoc -verison -author 源文件名字主要用...
  • Java注释

    千次阅读 2021-02-28 16:01:29
    单行注释://多行注释/**/文档注释:/***文档注释用于从源代码自动生成文档执行javadoc*命名根据源代码中的内容生成网页*@XXX */不同格式的注释可以嵌套。// Welcome1.java. Text-printing program...
  • Java标准注释及规范

    2021-03-05 11:53:32
    JAVA注释技巧1、空行和空白字符也是一种特殊注释。利用缩进和空行,使代码与注释容易区别,并协调美观。2、当代码比较长,特别是有多重嵌套时,为了使层次清晰,应当在一些段落的结束处加注释(在闭合的右花括号后...
  • 可以采用在.java类里面进行注释,通过注释生成类的说明文档的方法。一、.java注释的写法:Test1.java/*文档注释*//**此类是对数组进行取最值,排序等操作的@author张三@version1.0*/public classTest1{/**...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 286,074
精华内容 114,429
关键字:

java类上生成作者名的注释

java 订阅