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
构造函数注释
构造函数注释采用
/** … */
，描述部分注明构造函数的作用，不一定有块标记部分。
例如：
/**
*
默认构造函数
*/
有例如：
/**
*
带
相关文档：
import java.awt.*;
import javax.swing.*;
import java.util.Date;
import java.awt.*;
class Time extends JFrame implements Runnable{//实现接口
Thread clockThread;
JLabel jLabel=new JLabel();
public Time()
{
Container con=this.getContentPane() ......
对于学习static我们先来看两个例子：
//Example 1 Tst.java，no main() method
package com.blogchina.qb2049;
public class Tst
{
static { System.out.println("111111"); }
}
运行结果为: 111111
Exception in thread "main" java.lang.NoSuchMethodError: main
同样的道理看第二 ......
1.List转换成为数组。（这里的List是实体是ArrayList)
调用ArrayList的toArray方法。
例：String[] arr = (String[])list.toArray(new String[size]);
2.数组转换成为List。
调用Arrays的asList方法。
例：List stooges = Arrays.asList("Larry", "Moe", "Curly"); ......
一、运行class文件
执行带main方法的class文件，命令行为：
java <CLASS文件名>
注意：CLASS文件名不要带文件后缀.class
例如：
java Test
如果执行的class文件是带包的，即在类文件中使用了：
package <包名>
那应该在包的基路径下执行，命令行为：
java <包名>.CLASS文件 ......
1 网络通信的本质是进程间通信。
2 Tcp协议和UDP协议
TCP：开销大，用于可靠性要求高的场合。
TCP的过程相当于打电话的过程
UDP：用在对实时性要求比较高的场合。
UDP的过程相当于写信的过程。
注意：socket是套接字，ip和port（端口号 0~65535个端口，一个端口只能有一个进程）
3， ......
