• Eclipse 注释模板设置


    设置注释模板的入口:

    Window-<Preference-<Java-<CodeStyle-<Code Template 然后展开Comments节点就是所有需设置注释的元素。现就每一个元素逐一介绍:

    文件(Files)注释标签:

     

    /**  

     * Copyright © ${year}公司名字. All rights reserved.

     *

     * @Title: ${file_name}

     * @Prject: ${project_name}

     * @Package: ${package_name}

     * @Description: ${todo}

     * @author: ${user}  

     * @date: ${date} ${time}

     * @version: V1.0  

     */

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

     

    /**

     * @ClassName: ${type_name}

     * @Description: ${todo}

     * @author: ${user}

     * @date: ${date} ${time}

     * ${tags}

     */

    字段(Fields)注释标签:

     

    /**

     * @fieldName: ${field}

     * @fieldType: ${field_type}

     * @Description: ${todo}

     */

    构造函数标签:

     

    /**

     * @Title:${enclosing_type}

     * @Description:${todo}

     * ${tags}

     */

    方法(Constructor & Methods)标签:

     

    /**

     * @Title: ${enclosing_method}

     * @Description: ${todo}

     * ${tags}

     * @return: ${return_type}

     */

    覆盖方法(Overriding Methods)标签:

     

    /* (non Javadoc)

     * @Title: ${enclosing_method}

     * @Description: ${todo}

     * ${tags}

     * ${see_to_overridden}

     */

    代表方法(Delegate Methods)标签:

     

    /**

     * ${tags}

     * ${see_to_target}

     */

    getter方法标签:

     

    /**

     * @return the ${bare_field_name}

     */

    setter方法标签:

     

    /**

     * @param ${param} the ${bare_field_name} to set

     */


    或者可以从网上下载配置好的.xml文件导入也可以。下载请点击我!

     PS:在按照上面的方法设置后,一定要到windows->Preferences->general->Content Types,右侧Context Types树,点开Text,选择Java Source File,在下面的Default encoding输入框中输入UTF-8,点Update,则设置Java文件编码为UTF-8,否则会出现字符编码的问题。


    经过如上的设置后,就可以使用快捷键Alt+Shift+J来快速生成文档的注释了。使用方法如下:

    文件头注释:

    使用New->Class方法生成的文件会在创建类的对话框选项中提示是否生成注释,默认是选中的。这样生成的.java文件就有在文件头带有上面设置的版权信息。若是使用New->File方法建立的java文件则不会自动生成文件头的版权信息,必须手动输入。

    方法、类、字段等注释:

    这一类的注释只需要选中方法名、类名、或字段名,然后使用Alt+Shift+J来自动生成注释,然后补全信息即可。


  • 相关阅读:
    框架-.NET:Spring.Net
    杂项-WebService:WebService
    公司-企业内部创业:企业内部创业
    公司-内部创业:内部创业
    架构-软件系统体系结构-B/S架构:B/S架构
    架构-软件系统体系结构-C/S架构:C/S架构
    android google map v1 v2 v3 参考
    选购好的主机和服务器可以有效提高优化效果
    u盘安装ubuntu10.04 、11.04 server
    IOS学习笔记45--UITableView性能优化
  • 原文地址:https://www.cnblogs.com/duboway/p/Eclipse.html
Copyright © 2020-2023  润新知