Herramienta Eclipse --- Explicación detallada de la configuración de la plantilla de anotaciones

La entrada para configurar la plantilla de comentarios: Ventana-> Preferencia-> Java-> Estilo de código-> Plantilla de código y luego expanda el nodo Comentarios para que sean todos los elementos que necesitan ser comentados. Este artículo ahora presentará cada elemento uno por uno.

Etiqueta de comentario de archivo:

/ **
* @Title: $ {
file_name } * @Package $ {package_name}
* @Description: $ {todo} (Describe lo que hace el archivo en una oración)
* @author $ {user}
* @date $ {date}
* @version V1.0
* /

Escriba (Tipos) etiqueta de anotación (anotación de la clase):

/ **
* @ClassName: $ {type_name}
* @Description: $ {todo} (aquí una oración describe el rol de esta clase)
* @author $ {user}
* @date $ {date}
*
* $ {tags}
* /

Etiquetas de anotación de campos:

/ **
* @Fields field: field: (todo) (Describe en una oración lo que representa esta variable)
* /

Etiqueta de constructor:

/ **
* Crea una nueva instancia $ {enclosing_type}.
*
* $ {Tags}
* /

Ficha Métodos (métodos):

/ **
* @Title: $ {
enclosing_method } * @Description: $ {todo} (aquí para describir la función de este método en una oración)
* @param $ {tags} parámetros
* @return $ {return_type} tipo de retorno
* @throws
* /

Etiquetas de métodos de reemplazo (métodos de reemplazo):

/ * (非 Javadoc)
* <p> Título: $ {enclosing_method} </p>
* <p> Descripción: </p>
* $ {tags}
* $ {see_to_overridden}
* /

La etiqueta del método delegado (métodos delegados):

/ **
* $ {etiquetas}
* $ {see_to_target}
* /

Etiqueta del método getter:

/ **
* @return $ {bare_field_name}
* /

Etiquetas de método de Setter:

/ **
* @param paramtheparamthe {bare_field_name} para establecer
* /

Para implementar la plantilla de comentarios anterior, debe importar el siguiente archivo de configuración:

<?xml version="1.0" encoding="UTF-8"?>
    <templates>
        <template
                    autoinsert="false"
                    context="filecomment_context"
                    deleted="false"
                    description="Comment for created Java files"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
                    name="filecomment">
        /**
        * @Title: ${file_name}
        * @Package ${package_name}
        * @Description: ${todo}(用一句话描述该文件做什么)
        * @author ${user}
        * @date ${date}
        * @version V1.0
        */
        </template>
        <template
                    autoinsert="false"
                    context="typecomment_context"
                    deleted="false"
                    description="Comment for created types"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
                    name="typecomment">
        /**
        * @ClassName: ${type_name}
        * @Description: ${todo}(这里用一句话描述这个类的作用)
        * @author ${user}
        * @date ${date}
        *
        * ${tags}
        */
        </template>
        <template
                    autoinsert="false"
                    context="fieldcomment_context"
                    deleted="false"
                    description="Comment for fields"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
                    name="fieldcomment">
        /**
        * @Fields field:field:{todo}(用一句话描述这个变量表示什么)
        */
        </template>
        <template
                    autoinsert="false"
                      context="constructorcomment_context"
                    deleted="false"
                    description="Comment for created constructors"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
                    name="constructorcomment">
        /**
         * 创建一个新的实例 ${enclosing_type}.
         *
         * ${tags}
         */
        </template>
            <template
                    autoinsert="false"
                    context="methodcomment_context"
                    deleted="false"
                    description="Comment for non-overriding methods"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
                    name="methodcomment">
        /**
        * @Title: ${enclosing_method}
        * @Description: ${todo}(这里用一句话描述这个方法的作用)
        * @param ${tags}    参数
        * @return ${return_type}    返回类型
        * @throws
        */
        </template>
        <template
                    autoinsert="true"
                    context="overridecomment_context"
                    deleted="false"
                    description="Comment for overriding methods"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
                    name="overridecomment">
        /* (非 Javadoc)
        * <p>Title: ${enclosing_method}</p>
        * <p>Description: </p>
        * ${tags}
        * ${see_to_overridden}
        */
        </template>
            <template
                    autoinsert="true"
                    context="delegatecomment_context"
                    deleted="false"
                    description="Comment for delegate methods"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
                    name="delegatecomment">
        /**
         * ${tags}
         * ${see_to_target}
         */
        </template>
        <template
                    autoinsert="false"
                    context="gettercomment_context"
                    deleted="false"
                    description="Comment for getter method"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
                    name="gettercomment">
        /**
        * @return ${bare_field_name}
        */
        </template>
        <template
                    autoinsert="true"
                    context="settercomment_context"
                    deleted="false"
                    description="Comment for setter method"
                    enabled="true"
                    id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
                    name="settercomment">
        /**
         * @param paramtheparamthe{bare_field_name} to set
         */
        </template>
    </templates>

借鉴 https://blog.csdn.net/paul342/article/details/52982585

Herramienta Eclipse --- Explicación detallada de la configuración de la plantilla de anotaciones

Supongo que te gusta