Eclipse注释详解

设置注释模板的入口: 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}

*/

时间: 2024-08-12 05:19:15

Eclipse注释详解的相关文章

黑马程序员——注释详解

元注释:就是注释的注释 元数据:就是数据的数据 不同的注释会在不用的时期发挥作用,RetentionPolicy.SOURCE,RetentionPolicy.CLASS,RetentionPolicy.RUNTIME,分别 的是java中的源文件,class文件,内存中的字节码 Override和SuppressWarnings这两个对应的是SOURCE,Deprecated对应的是RUNTIME, 除了那三中基本都类型之外,还有: @Target 元注释 @Target(ElementTyp

springboot注释详解

1.@SpringBootApplication 为复合注解,包含: * @Configuration:表示将该类作用springboot配置文件类. *@EnableAutoConfiguration:表示程序启动时,自动加载springboot默认的配置.例如,如果你的classpath下存在HSQLDB,并且你没有手动配置任何数据库连接beans,那么我们将自动配置一个内存型(in-memory)数据库".你可以将@EnableAutoConfiguration或者@SpringBootA

mapreduce入门之wordcount注释详解

mapreduce版本:0.2.0之前 说明: 该注释为之前学习时找到的一篇,现在只是在入门以后对该注释做了一些修正以及添加. 由于版本问题,该代码并没有在集群环境中运行,只将其做为理解mapreduce的参考吧. 切记,该版本是0.2.0之前的版本,请分辨清楚! 正文: package org.apache.hadoop.examples; import java.io.IOException; import java.util.Iterator; import java.util.Strin

IE条件注释详解.

IE条件注释是微软从IE5开始就提供的一种非标准逻辑语句,作用是可以灵活的为不同IE版本浏览器导入不同html元素,如:样式表,html标签等.很显然这种方法的最大好处就在于属于微软官方给出的兼容解决办法而且还能通过W3C的效验. 让我们举几个例子来看看: 1.只有IE才能识别 1 <!--[if IE]> 2 <link type="text/css" rel="stylesheet" href="my.css" />

关于opencv中人脸识别主函数的部分注释详解。

近段时间在搞opencv的视频人脸识别,无奈自带的分类器的准确度,实在是不怎么样,但又能怎样呢?自己又研究不清楚各大类检测算法. 正所谓,功能是由函数完成的,于是自己便看cvHaarDetectObjects 这个识别主函数的源代码,尝试了解并进行改造它,以提高精确度. 可惜实力有限啊,里面的结构非常复杂,参杂着更多的函数体,有一些是网上找不到用法的,导致最终无法整体了解,只搞了一般,这里分享 下我自己总结的注释. 1 CvSeq* cvHaarDetectObjects( const CvAr

Java注释详解

在编写程序时,经常需要添加一些注释,用以描述某段代码的作用. 一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上.因此,注释是程序源代码的重要组成部分,一定要加以重视哦! Java 中注释有三种类型:单行注释.多行注释.文档注释 我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档. 打开首页,查看下生成的 API 文档 PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息: @author 标明开发该类模块的作者 @

eclipse重构详解(转)

重构是对软件内部结构的一种调整,目的是在不改变软件行为的前提下,提高其可理解性,降低其修改成本.开发人员可以使用一系列重构准则,在不改变软件行为的前提下,调整软件的结构. 有很多种原因,开发人员应该重构代码,例如之前的开发人员代码写得很烂.自己以前设计时有缺陷.需求变更需要添加一些新的功能或修改原有功能等等.Martin Fowler在其著名的<<Refactoring—Improving the Design of Existing Code>>一书中谈到了为何重构的几点原因:

Eclipse菜单栏详解

[转载]http://blog.csdn.net/mylotof/article/details/43986721 「File」菜单 这个菜单可以建立.储存.关闭.打印.汇入及汇出工作台资源以及结束工作台本身. 名称 功能 New(新建) 建立Java元素或新资源.配置哪些元素会显示在「Window」→「Preferences」的子菜单中.在Java视景中,依预设,会提供项目.套件.类别.接口.来源数据夹.实时运算簿.档案和数据夹的建立动作. Close(关闭) 关闭现行编辑器.如果编辑器中有资

Java基础入门 - 三种注释及文档注释详解

类似C/C++,Java也支持单行和多行注释 注释中的字符在编译时会被忽略 注释通常为类.变量和方法的主要描述 单行注释 // 注释内容 多行注释 /* 注释内容 */ /* * 注释内容 */ 文档注释 /** * 注释内容 */ 文档注释可使用javadoc工具来生成信息,并输出到HTML文件中,方便记录程序信息 文档注释中可包含一个或多个@标签,每个@标签都在新的一行开始 多个相同的标签应一个接一个的放在一起组成一组 实例:SquareNum.java import java.io.*;