eclipse代码注释说明

最新推荐文章于 2022-03-16 21:10:43 发布
最新推荐文章于 2022-03-16 21:10:43 发布
阅读量932 收藏
点赞数
分类专栏： eclispe

从某个地方复制过来的，忘记网址了，留个备份吧

 

网上某个地方复制的，网址忘记了，放在这里备份下：

设置注释模板的入口： Window->Preference->Java->Code Style->Code Template然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：

文件(Files)注释标签：

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author A18ccms A18ccms_gmail_com   
* @date ${date} ${time} 
* @version V1.0   
*/

类型(Types)注释标签（类的注释）：

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author A18ccms a18ccms_gmail_com 
* @date ${date} ${time} 
* 
* ${tags} 
*/

字段(Fields)注释标签：

/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 
构造函数标签：

/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

方法(Constructor & Methods)标签：

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param ${tags}    设定文件 
* @return ${return_type}    返回类型 
* @throws 
*/

覆盖方法(Overriding Methods)标签：

/* (非Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/

代表方法(Delegate Methods)标签：

/** 
* ${tags} 
* ${see_to_target} 
*/ 
getter方法标签：

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

setter方法标签：

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

简单模板例子： 
<?xml version="1.0"encoding="UTF-8"?><templates><templateautoinsert="true" context="fieldcomment_context"deleted="false" description="字段的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"name="fieldcomment">/**  
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
*/  
</template><template autoinsert="true"context="gettercomment_context" deleted="false"description="getter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"name="gettercomment">/**  
* @return ${bare_field_name}  
*/  
</template><template autoinsert="true"context="constructorcomment_context" deleted="false"description="创建的构造函数的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"name="constructorcomment">/**  
* <p>Title:${file_name} </p>  
* <p>Description: 构造函数</p>  
* ${tags}  
*/  
</template><template autoinsert="true"context="filecomment_context" deleted="false"description="已创建的 Java 文件的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.filecomment"name="filecomment">/**    
* @Title: ${file_name}  
* @Package ${package_name}  
* @Description: ${todo}(用一句话描述该文件做什么)  
* @author DAIGUANGJIU     
* @date ${date} ${time}  
* @version V1.0    
*/  
</template><template autoinsert="true"context="settercomment_context" deleted="false"description="setter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.settercomment"name="settercomment">/**  
* @param ${param} 要设置的 ${bare_field_name}  
*/</template><template autoinsert="true"context="typecomment_context" deleted="false"description="创建的类型的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment"name="typecomment">/**  
* @author ${user}  
*  
* ${tags}  
*/</template><template autoinsert="true"context="delegatecomment_context" deleted="false"description="代表方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"name="delegatecomment">/**  
* ${tags}  
* ${see_to_target}  
*/</template><template autoinsert="true"context="overridecomment_context" deleted="false"description="覆盖方法的注释" 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="methodcomment_context" deleted="false"description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"name="methodcomment">/**  
* ${tags}  
*/</template></templa  
<?xml version="1.0"encoding="UTF-8"?><templates><templateautoinsert="true" context="fieldcomment_context"deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"name="fieldcomment">/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 
</template><template autoinsert="true"context="gettercomment_context" deleted="false"description="getter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"name="gettercomment">/** 
* @return ${bare_field_name} 
*/ 
</template><template autoinsert="true"context="constructorcomment_context" deleted="false"description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"name="constructorcomment">/** 
* <p>Title:${file_name} </p> 
* <p>Description: 构造函数</p> 
* ${tags} 
*/ 
</template><template autoinsert="true"context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释"enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.filecomment"name="filecomment">/**  
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author DAIGUANGJIU   
* @date ${date} ${time} 
* @version V1.0  
*/ 
</template><template autoinsert="true"context="settercomment_context" deleted="false"description="setter 方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.settercomment"name="settercomment">/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/</template><template autoinsert="true"context="typecomment_context" deleted="false"description="创建的类型的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment"name="typecomment">/** 
* @author ${user} 
* 
* ${tags} 
*/</template><template autoinsert="true"context="delegatecomment_context" deleted="false"description="代表方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"name="delegatecomment">/** 
* ${tags} 
* ${see_to_target} 
*/</template><template autoinsert="true"context="overridecomment_context" deleted="false"description="覆盖方法的注释" 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="methodcomment_context" deleted="false"description="非覆盖方法的注释" enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** 
* ${tags} 
*/</template></templa

例子2： 
<?xml version="1.0" encoding="UTF-8"?>  
<templates>  
    <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="true"    
               context="settercomment_context"  
               deleted="false"    
               description="Comment for setter method"    
               enabled="true"    
               id="org.eclipse.jdt.ui.text.codetemplates.settercomment"    
               name="settercomment">  
    /**   
     * @param ${param} the ${bare_field_name} to set   
     */   
    </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">  
    /**   
     * 此方法描述的是：   
     * @author: wangxiongdx@163.com   
     * @version: ${date} ${time}   
     */   
    </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="filecomment_context"    
               deleted="false"    
               description="Comment for created Java files"    
               enabled="true"    
               id="org.eclipse.jdt.ui.text.codetemplates.filecomment"    
               name="filecomment">  
    /**   
     * 文件名：${file_name}   
     *   
     * 版本信息：   
     * 日期：${date}   
     * Copyright 足下 Corporation ${year}    
     * 版权所有   
     *   
     */   
    </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">  
    /**   
     * ${bare_field_name}   
     *   
     * @return  the ${bare_field_name}   
     * @since   CodingExample Ver(编码范例查看) 1.0   
    */   
    </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">  
    /* (non-Javadoc)   
     * ${see_to_overridden}   
     */   
    </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">  
    /**   
     * ${field}:${todo}（用一句话描述这个变量表示什么）   
     *   
     * @since Ver 1.1   
     */   
    </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">  
    /**   
     * 此类描述的是：   
     * @author: wangxiongdx@163.com   
     * @version: ${date} ${time}    
     */   
    </template>  
</templates>  
<?xml version="1.0" encoding="UTF-8"?> 
<templates> 
    <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="true" 
               context="settercomment_context" 
               deleted="false" 
               description="Comment for setter method" 
               enabled="true" 
               id="org.eclipse.jdt.ui.text.codetemplates.settercomment" 
               name="settercomment"> 
    /** 
     * @param ${param} the ${bare_field_name} to set 
     */ 
    </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"> 
    /** 
     * 此方法描述的是： 
     * @author: wangxiongdx@163.com 
     * @version: ${date} ${time} 
     */ 
    </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="filecomment_context" 
               deleted="false" 
               description="Comment for created Java files" 
               enabled="true" 
               id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 
               name="filecomment"> 
    /** 
     * 文件名：${file_name} 
     * 
     * 版本信息： 
     * 日期：${date} 
     * Copyright 足下 Corporation ${year} 
     * 版权所有 
     * 
     */ 
    </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"> 
    /** 
     * ${bare_field_name} 
     * 
     * @return  the ${bare_field_name} 
     * @since   CodingExample Ver(编码范例查看) 1.0 
    */ 
    </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"> 
    /* (non-Javadoc) 
     * ${see_to_overridden} 
     */ 
    </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"> 
    /** 
     * ${field}:${todo}（用一句话描述这个变量表示什么） 
     * 
     * @since Ver 1.1 
     */ 
    </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"> 
    /** 
     * 此类描述的是： 
     * @author: wangxiongdx@163.com 
     * @version: ${date} ${time} 
     */ 
    </template> 
</templates>

 


yuyan19850204
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Eclipse 代码注释模板
12-18
在Eclipse中，用户可以自定义代码注释模板，这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件，通过编辑这个文件，我们可以定制符合个人或团队编码规范的...
eclipse代码注释风格
04-24
Eclipse是一款广泛使用的Java集成开发环境（IDE），它提供了丰富的功能来支持开发者遵循特定的代码注释风格。本文将详细讲解Eclipse中的代码注释风格，以及如何设置和使用这些风格。 一、代码注释类型 Eclipse支持...
用eclipse解释器解释java的程序代码（收银情况的程序代码）希望对你有用
hua20030820的博客
03-16 603
金额和单价都有可能出现小数，所以应用浮点型定义；由于数量不会出现小数， 所以用整型定义。输出结果中的空格可以通过手动在输出语句的双 本案例的源代码中使用的是“t”，这是一个制表符，即按照表格的形式输出内容 在计算积分的时候分的时候，每消费10元积1分，所以其表达式为总金额除以10，但是直接计算出来的结果可能会出现小数，所以在给积分变量integral赋值的时候进行了强制类型转化，将浮点型强制换成整型。 虽然这个程序比较简单，但其综合了数据类型、运算符及数 同学们在Eclipse中编写该程序并运行，加深对案例
A003_Eclipse_基础语法_数据类型_常量_变量
窗外有风景，笔下有前途，低头是题海，抬头是未来
06-06 1522
Eclipse_基础语法_数据类型_常量_变量
在使用eclipse开发android过程中，注释的使用细节
洋葱先生的技术博客
05-11 1981
引文在商业项目的实施过程中，大部分都是协同开发，svn和git等一系列版本控制软件，在代码管理方面提供了很多便利。但是由于是协同开发，在业务方面就会存在很多交集，需要互相提供支持，所以需要将自己产出的代码进行一系列的注释说明。后期由于因为的展开，逻辑逐渐趋于复杂，为了方便追溯，就需要很完整的注释存在。所以，一个具备专业素养的程序员，产出的代码，注释是占了很大比重的。接下来，一起分析一下，在使用ecl
Eclipse中代码的注释模块
小思的博客
10-28 862
拥有一个良好的编码习惯是一个程序员必备的条件，那怎样可以逐渐拥有这个习惯呢？首先形成自己的代码注释的风格，方便项目过后的维护与项目的交接。 下面的是各类注释的截图 注释文件的下载地址： 文件有详细的教程与编码，需要的小伙伴可以自行下载与设置~ 说在最后的话：编写实属不易，若喜欢或者对你有帮助记得点赞+关注或者收藏哦~ ...
eclipse 代码的 模板注释--代码注释
chuncui2576的博客
09-23 54
/** * @author oumin * @date ： ${date} * ${tags} */ 可以在 eclipse的 --perference--java--code Style--code templets--types 里面进行这样设置的 ...
eclipse代码/注释规范
01-08
以下是一些关于Eclipse代码和注释规范的关键知识点： 1. **编码风格**：Eclipse支持多种编码风格，如Sun Java编程规范或Google Java编程规范。这些风格通常规定了命名约定（如变量、类和方法名）、缩进和空格的使用...
eclipse注释模板
05-16
代码格式化和代码注释规范，导入eclipse中，一般在类和方法上都必须加通用文档注释，说明类和方法的作用，在特殊字段加相应注释，在复杂代码逻辑加相应行内注释说明代码逻辑。
Eclipse Java注释模板.txt
07-09
Eclipse作为一款非常受欢迎的Java集成开发环境（IDE），提供了强大的功能来支持用户自定义代码注释模板，这有助于保持代码的一致性和可读性。 #### 二、Eclipse Java注释模板配置方法 要在Eclipse中设置Java注释...
eclipse代码格式化模板和注释格式化模板
10-24
eclipse代码格式化模板和注释格式化模板，需要的请自行下载。
Eclipse注释大全
stryker的专栏
01-03 802
1.选中你要加注释的区域，用ctrl+shift+C 会加上//注释 2.先把你要注释的东西选中，用shit+ctrl+/ 会加上/*    */注释 3.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了(转) 补充：选中要加注释的区域，ctrl+/ 会加//注释 2010/09/13 选
Eclipse注释模板设置详解
paul342的专栏
10-31 5万+
设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。 文件(Files)注释标签： /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${to
MyEclipse 新手使用教程---图文详解
热门推荐
虚无境的博客
09-23 9万+
引言某天在群里看到有小伙伴问MyEclipse/Eclipse的一些使用问题，虽然在我看来，问的问题很简单，但是如果对于刚刚学习的人来说，可能使用就不那么友好了。毕竟我在开始使用MyEclipse/Eclipse 的时候，也是有很多不懂，即使是现在也不敢说将MyEclipse/Eclipse 的功能全部摸透。 因此写下一篇博文，来将自己使用MyEclipse/Eclipse 的经验分享下。如果有的说
Eclipse get/set方法自动加上字段注释
雅库无忧
09-02 378
2014年8月，添加Eclipse4.3.2版本的GetterSetterUtil     编码的时候通常要用到 JavaBean ，而在我们经常把注释写在字段上面，但生成的Get/Set方法不会生成，通过修改Eclipse源码可解决，直接上例子： /** * 员工ID */ private String userid; /** * 获取员工ID * @return...
Eclipse 注释模板设置详解
心疼笔记本
10-24 440
/**  * @return the ${bare_field_name}  */     /**  * @param ${param} the ${bare_field_name} to set  */     /**    * <p>Title: </p>    * <p>Description: </p>    * ${tag
Eclipse Java注释模板设置详解
qq_38136705的博客
06-19 79
Eclipse Java注释模板设置详解设置注释模板的入口： Window-&gt;Preference-&gt;Java-&gt;Code Style-&gt;Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：文件(Files)注释标签：/**   * @Title: ${file_name} * @Package ${package_n...
Eclipse自动生成作者、日期注释等功能设置
dengweijunkedafu的专栏
06-09 1569
在使用Eclipse 编写Java代码时，自动生成的注释信息都是按照预先设置好的格式生成的。 修改作者、日期注释格式：打开Windows->Preferences->Java->Code Style->Code Templates，点击右边窗口中的Comments，可以看到有很多选项，我们便可对此注释信息模板进行编辑。 如我们希望在一个Java文件的开头设置作者信息、日期信息。
如何在Eclipse中如何自动添加注释和自定义注释风格
光阴迷客的知识库
07-22 4万+
背景简介 丰富的注释和良好的代码规范，对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的，往往会形成自己的一套编码规范。但是再实施过程中，如果全靠手动完成，不仅效率低下，还难以保证真正的符合规范。所以结合IDE环境，自动生成注释，还是很有必要的。今天我们就说一下，如何使用Eclipse给我们提供的自定义代码模版的功能来作业。 设置注释模板 设置注释...
eclipse注释代码怎样注释
最新发布
06-12
在Eclipse中，注释代码非常直观且易于操作。下面是几种常用的注释方式： 1. **单行注释**： 使用 `//` 前面添加文本，这是最常见的Java单行注释。例如： ``` // 这是一个单行注释 ``` 2. **多行注释**（使用 `/* ... */`）： 选中多行代码后，可以在开始和结束位置分别输入 `/*` 和 `*/`，如： ``` /* 这是一个多行注释， 描述这部分代码的功能。 */ ``` 3. **Javadoc注释**（用于API文档）： 对于方法、类或变量，可以使用 `/** ... */`，格式更详细，例如： ``` /** * 这是Javadoc注释，用于文档生成工具自动生成API文档。 * @param param 参数描述 * @return 返回值描述 */ public String myMethod(String param) { // ... } ``` Javadoc注释通常包含参数、返回值、@throws等元素。 4. **HTML注释**： 使用 `<!-- ... -->` 可以插入HTML格式的注释，对于显示在帮助文档中的文本更合适。 5. **代码块注释**（如JavaDoc的`@code`）： 如果想引用源代码片段，可以使用 `@code` 标签，如： ``` `@code` int result = calculateSomething(); ``` 要在Eclipse中添加或编辑注释，只需点击代码区域然后选择相应的选项或者使用快捷键（通常是Ctrl+Shift+/或Ctrl+/）。记住，良好的注释习惯能帮助其他开发者理解你的代码。如果你有任何特定的问题或者需要关于某个注释功能的深入说明，请告诉我，我会进一步解释。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值