在Eclipse中怎样写Java注释

时间:2021-06-04 08:52:31

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

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

在Eclipse中怎样写Java注释

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

在Eclipse中怎样写Java注释

一、文件注释

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

在Eclipse中怎样写Java注释

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

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

二、类、接口注释

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

在Eclipse中怎样写Java注释

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

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

在Eclipse中怎样写Java注释

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

在Eclipse中怎样写Java注释

在上面的例子中,@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中出现,比如

在Eclipse中怎样写Java注释

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

四、方法注释

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

在Eclipse中怎样写Java注释

/**
*
* @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. 【转】算法杂货铺——k均值聚类(K-means)

    k均值聚类(K-means) 4.1.摘要 在前面的文章中,介绍了三种常见的分类算法.分类作为一种监督学习方法,要求必须事先明确知道各个类别的信息,并且断言所有待分类项都有一个类别与之对应.但是很多时 ...

  2. 在easyui的treeGrid中添加checkbox(jquery)

    jsp界面,也可用在aspx.html等前台界面中: <script type="text/javascript"> function show(checkid){ v ...

  3. 简单的php数据库操作类代码&lpar;增&comma;删&comma;改&comma;查&rpar;

    这几天准备重新学习,梳理一下知识体系,同时按照功能模块划分做一些东西.所以.mysql的操作成为第一个要点.我写了一个简单的mysql操作类,实现数据的简单的增删改查功能. 数据库操纵基本流程为: 1 ...

  4. javascript中字符串常用操作整理

    javascript中字符串常用操作整理 字符串的操作在js中非常频繁,也非常重要.以往看完书之后都能记得非常清楚,但稍微隔一段时间不用,便会忘得差不多,记性不好是硬伤啊...今天就对字符串的一些常用 ...

  5. L2-022 重排链表 (25 分&rpar;

    L2-022 重排链表 (25 分)   给定一个单链表 L​1​​→L​2​​→⋯→L​n−1​​→L​n​​,请编写程序将链表重新排列为 L​n​​→L​1​​→L​n−1​​→L​2​​→⋯.例 ...

  6. 洛谷P4725 【模板】多项式对数函数&lpar;多项式ln&rpar;

    题意 题目链接 Sol 这个不用背XD 前置知识: \(f(x) = ln(x), f'(x) = \frac{1}{x}\) \(f(g(x)) = f'(g(x)) g'(x)\) 我们要求的是\ ...

  7. asp gridview

    <table> <tr> <td colspan="5">请选择试卷制定人员<span style="color:red&quo ...

  8. ARCore中Pose类变换点的算法实现

    ARCore中Pose类变换点的算法实现,主要分为两步,分别是平移和旋转. 1. 旋转向量:通过四元数计算旋转后的向量 参数列表:q表示四元数, v是长度为4的float数组,表示待旋转的向量,   ...

  9. 转 VS2010 RDLC 横向合并时&OpenCurlyDoubleQuote;未正确设置 tablix&OpenCurlyDoubleQuote;Tablix1”的 FixedData 属性”错误解决方法 &period;

    最近在使用Rdlc做报表打印,有些报表的表头需要合并表头.Rdlc本身提供了横向合并的工具,但是在实际合并的时候,会出现“未正确设置 tablix“Tablix1”的 FixedData 属性.除非在 ...

  10. Memcache 分布式高可用集群介绍

    分布式缓存需考虑如下三点: 1.缓存本身的水平线性扩展的问题. 2.缓存大病罚下的本身性能问题. 3.避免缓存的单点鼓掌问题. 分布式缓存存在的问题: 1.内存本身的管理问题.内存的分配,管理和回收机 ...