java中的注释分为实现注释和文档注释

实现注释就是那些/……../和//……的注释,是注释程序用的,文档注释是/*……./的注释,是用来生成javadoc的。设置方法如下:
1.打开Eclipse的偏好设置:

2.依次选择Java > Code Style > Code Template > Comments:

一、文件注释

文件头注释以 /开始,以/结束,其中列出类名,版本信息,日期和版权声明。
选择comments下的Files,点击Edit进行编辑:

/*
* ${file_name}
* Version 1.0.0
* Created on ${date}
* Copyright QuickCodes.net
*
*/

设置好了之后,你新建类的时候ec就会自动帮你生成文件注释了。

二、类、接口注释

类、接口注释/*开始,以/结束,作为类或接口的介绍信息出现在生成的javadoc中。一般写成下面这样。

/**
* @author ${user}
* @version 1.0.0
* @since
* ${tags}
* 创建时间:${date}
* 功能描述:
* 官方网站:www.QuickCodes.net
* 邮箱地址:Mac.Manon@QuickCodes.net
*/

使用方法:
新建一个类后,在类声明的地方输入“/**”:

回车后自动生成如下注释:

在上面的例子中,@author、@version和@see是标记。标签分为块标签(block tag)和内联标签(inline tag)。块标签直接@tag来用,内联标签是{@tag}来用的。下面介绍几个常用的块标签

@author

用在类注释中,表示作者。函数注释里面可以不出现@author。

@version

用在类注释中,表示版本信息。函数注释里面可以不出现@version。

@since

用在类注释中,标明该类可以运行的JDK版本

@param标记

@param标记后跟的是方法的参数名,注意不是参数类型。

@return标记

@return后跟的是方法的返回值类型。返回为空(void)的构造函数或者函数,@return可以省略。

关于注释标签的详细信息可以看http://java.sun.com/j2se/javadoc/writingdoccomments/#tag

三、属性注释(field)

可以是实现注释也可以是文档注释,如果是文档注释,会在javadoc中出现,比如

/** 用户ID */
private Integer userID; /** 用户名 */
private String userName;

四、方法注释

方法注释采用 /** … */,描述部分注明方法的功能,块标记部分注明方法的参数,返回值,异常等信息

/**
*
* @param userName
* @param password
* @return
*/
public String doLogin(String userName,String password){
return "loginsuccess";
}

关于java的注释规范可以详见http://java.sun.com/j2se/javadoc/writingdoccomments/

在Eclipse中怎样写Java注释的更多相关文章

  1. Eclipse中各种文件的注释与取消注释的快捷键

    Eclipse中各种文件的注释与取消注释的快捷键 Java文件: 注释和取消注释的快捷键都是:CTRL + / 或 Shift+Ctrl+C JS文件: 注释和取消注释的快捷键都是:CTRL + / ...

  2. eclipse中生成文档注释--javadoc的使用

    1.针对于单一的JAVA文件,在终端窗口中,使用 javadoc 文件名.java 即可生成文档注释: 2.在eclipse中生成文档注释: ①单击eclipse菜单栏中的[Project]菜单,该菜 ...

  3. 在命令行中运行eclipse中创建的java项目

    在命令行中运行eclipse中创建的java项目 博客分类: java相关 javaeclipse命令行  由于项目要求,需要对eclipse中的项目进行打包,似的可以在客户机上不装eclipse的情 ...

  4. 将Eclipse中现有的java类生成类图

    需求:将Eclipse中现有的java类生成类图 一:什么是ModelGoon? 它是一个Eclipse插件,用于基于UML图的模型设计,以及逆向工程(即从已有源代码生成类图). 二:安装 下载Mod ...

  5. eclipse 中使用中文JAVA api文档

    http://hi.baidu.com/danghj/item/7625a1be20946e43ba0e1202在eclipse中使用中文JAVA api文档Sun 官方的中文版 Java API 文 ...

  6. java editor template Eclipse中的快速Java\JavaScript代码模板使用

    java editor template Eclipse中的快速Java\JavaScript代码模板使用 学习了:http://technicalsearch.iteye.com/blog/2150 ...

  7. eclipse中如何将java项目转为java Web项目

    有时候我们在eclipse中导入web项目时,系统当做一个java项目导入进来了.这时候在启动tomcat的服务器时无法找到该项目. 那么可以通过如下操作来将java项目转换为web项目. 1. 选择 ...

  8. java web:在eclipse中如何创建java web 项目

    Eclipse创建java web工程 eclipse版本:eclipse-jee-4.5-win32-x64 tomcat版本:apache-tomcat-7.0.63-windows-x64 jd ...

  9. 如何在Eclipse中Debug调试Java代码

    背景 有的时候你想debug调试Java的源代码,就想试图在Java源代码中设置断点,在Eclipse中常常会出现Unable to insert breakpoint Absent Line Num ...

随机推荐

  1. C#基础-可访问性-public、ptotected、protected internal、internal、private

    1.类型的可访问性 a.关键字有public.internal,其中public表示该类型对于程序集都可见.internal表示该类型仅对当前程序集可见.此处的类型可以为类.接口.结构等. b.如果不 ...

  2. Error Domain=kCLErrorDomain Code=0 "The operation couldn’t be completed.

    地图定位 错误:使用CoreLocation获取地理位置信息,报错 Error Domain=kCLErrorDomain Code=0 "The operation couldn’t be ...

  3. 安装C-Kermit串口访问开发板

    linux下的串口调试工具主要有minicom和kermit. minicom的安装与使用见博文: http://www.cnblogs.com/tanghuimin0713/p/3562218.ht ...

  4. 最新CSS3常用30种选择器总结(适合初学者)

     1. *:通用元素选择器 * { margin: 0; padding: 0; } *选择器是选择页面上的全部元素,上面的代码作用是把全部元素的margin和padding设为0,最基本的清除默认C ...

  5. Elipse安装Spring Tool Suite

    STS实际上是对Eclipse的Spring包装,下载STS IDE可以直接开发spring web. 但大多数人还是喜欢使用eclipse.下面就eclipse安装sts插件做个介绍. 1.首先到s ...

  6. SQL服务器更改名称后

    SQL服务器更改名称后 编写人:CC阿爸 2014-6-15 在日常SQL 2005数据库的操作中,有时安装完成数据库后,再更名,造成部分SQL服务不能正常使用(在SQL2000 时,想都别想更名了) ...

  7. Spark自定义分区(Partitioner)

    我们都知道Spark内部提供了HashPartitioner和RangePartitioner两种分区策略,这两种分区策略在很多情况下都适合我们的场景.但是有些情况下,Spark内部不能符合咱们的需求 ...

  8. 【Zend Studio】10.6.0版本设置默认字体

    1.打开Windows->Prefefences 2.找到General->Appearance->Colors and Fonts->Basic->Text Font- ...

  9. 7)Java数据类型

        Java中的数据类型分为基本数据类型和引用数据类型:   1)基础数据类型有:            boolean, byte.short.char, int.float.long, dou ...

  10. Winform开发几个常用的开发经验及知识积累(一)

    本人做Winform开发多年,孜孜不倦,略有小成,其中收集或者自己开发一些常用的东西,基本上在各个项目都能用到的一些开发经验及知识积累,现逐步介绍一些,以飨读者,共同进步. 1.窗口[×]关闭按钮变为 ...