Java注释规范
Java注释规范
2007年03月27日 星期二 14:01
Java
代码规范
--
注释
@author LEI
@version 1.10 2005-09-01
1
注释文档的格式
注释文档将用来生成
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);
}
前两行为描述，描述完毕后，由
@
符号起头为块标记注视。
2
注释的种类
2.1
文件头注释
文件头注释以
/*
开始，以
*/
结束，需要注明该文件创建时间，文件名，命名空间信息。
例如：
/*
* Created on 2005-7-2
* /
2.2
类、接口注释
类、接口的注释采用
/** … */
，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。
例如：
/**
Title: XXXX DRIVER 3.0
*
Description: XXXX DRIVER 3.0
*
Copyright: Copyright (c) 2003
*
Company:XXXX有限公司
*
* @author Java Development Group
* @version 3.0
*/
例如：
/**
* A class representing a window on the screen.
* For example:
*
*
Window win = new Window(parent);
*
win.show();
*
*
* @author
Sami Shaio
* @version %I%, %G%
* @see
java.awt.BaseWindow
* @see
java.awt.Button
*/
class Window extends BaseWindow {
...
}
2.3
构造函数注释
构造函数注释采用
/** … */
，描述部分注明构造函数的作用，不一定有块标记部分。
例如：
/**
*
默认构造函数
*/
有例如：
/**
*
带
相关文档：
举例子说明一切。
JAVA_HOME： C:\j2sdk1.4.2_13
Path： C:\j2sdk1.4.2_13\bin;
Classpath：.;JAVA_HOME\lib\tools.jar ; JAVA_HOME\lib\dt.jar;
&n ......
这是一个用JAVA W3C DOM 进行XML操作的例子，包含了查询、增加、修改、删除、保存的基本操作。较完整的描述了一个XML的整个操作流程。适合刚入门JAVA XML操作的朋友参考和学习。
假设有XML文件：test1.xml
<?xml version="1.0" encoding="UTF-8"?>
<books>
<book>
< ......
Bean Serializable Interface 的接口让BEAN可以串行化，将其变成一个可保存为以后使用的二进制流。当一个BEAN被系列化到磁盘上或者其他任何地方，其状态被保存起来，其中的属性值也不会改变。在BEAN的规范中，JSP并没有要求BEAN实现Serializable接口。但是，如果您希望自己控制您所创建的组件的serialization进程，或者您想 ......
Java编程那些事儿52—方法声明
第七章 方法
方法的来源
方法的概念来源于数学上的函数，在数学中，当数据具有一定的规律时，就是用一个函数来代码该数字的规律，例如f（n）=n则代表1、2、3、……这样的一个数列。在数学上n是参数，对于确定的n值只有一个f（n）的值和它对应
方法是一组为了实现特定功� ......
转帖处：http://dong-java.javaeye.com/blog/375150
1。推荐使用Oralce比较新的10.2.0.3 JDBC Drivers。这个版本对比9.2的最大的好处是DriverManager.setLoginTimeout函数是起作用的。设置了这个参数，在恶劣的网络环境中就不会有连接数据库的函数长时间不返回的情况。
2。JDBC Developer!ˉs Guide and Refer ......
