java 注释
2012-05-12 20:33 youxin 阅读(853) 评论(0) 编辑 收藏 举报对于Java注释我们主要了解三种：
1, // 注释一行
2, /* ...... */ 注释若干行 (选中代码，注释ctrl+shift+/",取消ctrl+shift+\）
3, /**……*/文档注释 写入 javadoc 文档
注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。
例如：
/** * The doGet method of the servlet. * This method is called when a form has its tag value method equals to get. * * @param request * the request send by the client to the server * @param response * the response send by the server to the client * @throws ServletException * if an error occurred * @throws IOException * if an error occurred */ public void doGet (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doPost(request, response); }
前两行为描述，描述完毕后，由@符号起头为块标记注视。
简单一点的例子：
/** * 银行账户类，有一个可被存取款操作改变的余额 * @author Administrator * */ public class Bank { /**] * 从银行账户中取款 * @param amount 取款金额 */ public void deposit(double amount) { //方法体，以后写入 } /** * 查询银行账户的当前余额 * @return 当前余额 */ public double getBalance() { //方法体，以后写入 return (double)3; } public static void main(String[ ] args) { new Bank(); } }
如果返回值是void，可以忽略@return
1、源文件注释 源文件注释采用 /** …… */，在每个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：
/**
* 文 件 名 :
* CopyRright
* 文件编号：
* 创 建 人：
* 日 期：
* 修 改 人：
* 日 期：
* 描 述：
* 版 本 号：
*/
2. 类（模块）注释：
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。
英文注释模版：
/**
* CopyRright
* Project:
* Module ID:
* Comments:
* JDK version used:
* Namespace:
* Author：
* Create Date：
* Modified By：
* Modified Date:
* Why & What is modified
* Version:
