eclipse代码注释的设置

article/2025/10/19 5:32:58

1. eclipse用户名的设置:

在eclipse的安装路径下,打开eclipse.ini的配置文件,如下图:

在-vmargs下加入:-Duser.name=你的名字


2. 注释格式以及各个主要简介

(1).单行(single-line)注释:“//……”

(2).块(block)注释:“/*……*/”

(3).文档注释:“/**……*/”

(4).javadoc注释标签语法

@author   对类的说明标明开发该类模块的作者

@version   对类的说明标明该类模块的版本

@see    对类、属性、方法的说明参考转向,也就是相关主题

@param    对方法的说明对方法中某参数的说明

@return   对方法的说明对方法返回值的说明

@exception  对方法的说明对方法可能抛出的异常进行说明

@return_type返回类型

@date 日期

@time时间

 

3类、方法、重写方法等类型的注释添加

打来:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点,选中你要添加注释的类型,

然后点击edit,就是所有需设置注释的元素。现就每一个元素逐一介绍:

点击edit后,在pattern里按“ctrl“+”/”键,选择要添加的种类,例如日期,作者、时间、返回类型等等……

设置好以后,会在上图的pattern下生成相应代码,如下图所示:

(1)文件(Files)注释标签:

目前没有用到,可以不用设置。

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

规范:

/**

 * 类的描述

 * @authoryourname

* @Time 2012-11-20 14:49:01

 *

 */

注释的pattern:

/**

 * @Description:${todo}

 * @author:${user}

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

 */

(3)字段(Fields)注释标签:

/**
* @Description: ${field} : ${todo}(用一句话描述这个变量表示什么)
*/

暂时用不到


(4)构造函数标签(Constructor):

规范:

/**

     * 构造方法的描述

     * @param name

     *       按钮的上显示的文字

     */

 

Pattern:

/**

 * @Description:${todo}

 * ${tags}

 */

(5)方法(Methods)标签:(接口和其实现类的方法,都要加注释)

注释规范:

/**

     * 为按钮添加颜色

     *@param color

按钮的颜色

*@return

*@exception  (方法有异常的话加)

* @author Administrator

* @Time 2012-11-20 15:02:29

 

     */

 

Pattern:

 

/**

 * @Description:${todo}

 * ${tags}

 * ${return_type}

 * @exception:

 * @author: ${user}

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

 */

(6)覆盖方法(Overriding Methods)标签:

(7)代表方法(Delegate Methods)标签:
(8)getter方法标签:

(9)setter方法标签:

这些暂时没有定义,可以按照自己的方式添加注释。

 


 





http://chatgpt.dhexx.cn/article/UQIMATF1.shtml

相关文章

Eclipse 中添加注释,注释中包含作者时间等

Eclipse 中添加注释,注释中包含作者时间等 在使用Eclipse工作是,为了防止有人程序报错甩锅给自己,我们一般都会在Eclipse中添加注释,注释内容一般包括:作者、时间、类别、版本号等,来鉴别区分。 下面我来介…

【eclipse修改默认注释】

【eclipse修改默认注释】 一、背景简介 丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范。但是再实施过程中,如果全靠手动完成,不…

eclipse中注释的技巧

首先eclipse中有三种注释 1Add block comment 添加块注释 选中多行 按下快捷键 形成形如“/**/”的注释 默认快捷键 添加注释:ctrlshift/ 取消注释:ctrlshift\ 2toggle comment (绿色注释) 也可以多行(前提是选中…

测试用例的设计要素以及设计测试用例的方法

本篇文章主要是为了讲述测试用例的设计要素以及设计方法 1、定义:测试用例是为了达到特定的目的而设计的一组测试输入、执行条件和预期结果的文档。 2、设计测试用例的要素:(有八大要素) ①、用例编号:也就是用例的i…

测试用例设计方法有哪些?举例说明

众所周知,测试用例是编制的一组测试输入、执行条件及预期结果,专门为的是某个特殊目标,即测试某个程序路径,或是核实是否满足某个特定的需求。一般来讲,常用的测试用例设计方法有五种,分别是:正…

测试新人如何编写测试用例以及八大要素和设计方法

目录 前言: 测试用例是每个测试新人必会经历的,最近有很多的转行的小伙伴私信凡叔,测试用例怎么写啊,这不就安排上了吗,直接上干货。 【文章末尾给大家留下了大量的福利】 1、测试用例编写依据 2、测试用例的组成元…

测试用例应包含的内容有哪些?

例图: 如图所示测试用例的内容应有以下内容: 项目名称,软件版本,测试环境,设计人,最新更新日期 序号,模块,子模块,用例分类,用例标题,前提条件,操作步骤(输入值),期望结果,实际结果,备注,更新日期,用例级别,评审人 解释: 项目名称:测试的项目名称。 …

测试用例的基本介绍

1.什么是测试用例? 测试用列(Test Case)是为了实施测试而向被测试的系统提供的一组集合,这组集合包含:测试环境、操作步骤、测试数据、预期结果等要素。 2.测试用例的要素 测试用例的标题、测试思路、预设条件、步骤…

测试用例基本内容

为什么需要测试用例 设计测试用例是为了更有效、更快地发现软件缺陷 测试用例具有很高的有效性和可重复性,依据测试用例进行测试可以节约测试时间,提升测试效率 测试用例具有良好的组织性和可跟踪性,有利于测试的管理 什么是测试用例 测试…

测试用例8大要素及额外10小要素【建议收藏】

测试用例八大要素 1.测试用例编号 由字母、字符、数字组合而成的字符串,有唯一性,易识别性。 eg: 1)系统测试:产品编号-ST-系统测试项名-系统测试子项名-编号 2)集成测试:产品编号-IT-集成测试项名-集成测试子项名-编号 3)单元测试:产品编号-UT-单元测试…

测试用例的基本要素和设计方法

作者:爱塔居 专栏:软件测试 作者简介:大三学生,希望同大家一起进步! 文章简介:介绍写测试案例的功能需求测试和非功能需求测试和具体方法:判定表、正交表、等价类、边界值等 文章目录 目录 文章…

测试用例设计的八大要素及ANSI/IEEE 829标准和编写示例

1、测试用例的八大要素 1. 用例编号 和其他编号一样,测试用例编号是用来唯一识别测试用例的编号,要求具有易识别和易维护性,用户可以很容易根据用例编号获取到相应用例的目的和作用,在系统测试用例中,编号的一般格式…

常用八大测试用例设计方法

1、等价类划分(Equivalance Partitioning)测试的思想:将程序的输入域划分为若干个区域(等价类),并在每个等价类中选择一个具有代表性的元素生成测试用例。该方法是常用的黑盒(Blackbox Testing&…

软件测试之用例编写的八大要素

用例编写的八大要素 1、用例编号:产品名-测试阶段-测试项XXX英文(wechat_st_register_001) 2、测试项目:功能模块–子项目 3、测试标题:测试点的细化,一行一个测试点 4、重要级别P1(冒烟&#…

软件测试:测试用例八大要素模板

一、通用测试用例八要素   1、用例编号;   2、测试项目;   3、测试标题;   4、重要级别;   5、预置条件;   6、测试输入;   7、操作步骤;   8、预期输出 二、具体分析通用测试…

测试用例编写八大要素

编写测试用例的8大要素有:用例编号,所属模块,测试标题,重要级别,前置条件,测试输入,操作步骤,预期结果。以及编写测试用例时的注意事项 。 一、用例编号 由字符和数字组合成的字符…

测试用例的设计方法——八大要素

一、测试用例(Test Case): 是为某个特殊目标而编制的一组测试输入、执行条件以及预期结果,以便测试某个程序路径或核实是否满足某个特定需求。 用例编号 功能模块 测试点 重要级别 预置条件 测试输入 操作步骤 预期结果 1…

UML 交互概述图

•什么是交互概述图 •交互概述图是将活动图和顺序图嫁接在一起的图 •可以看作活动图的变体,它将活动节点进行细化,用一些小的顺序图来表示活动节点内部的对象控制流 •也可以看作顺序图的变体,它用活动图来补充顺序图 •交互概述图在…

UML-交互图-序列图和协作图

文章目录 1.是交互图2.序列图(Sequence Diagram)/协作图(Collaboration Diagram)3. 序列图构成3.1object(对象)3.2 lifeline(生命线)3.3 message(消息) 4.协作…