Java原程序注释规范 Java class commentting standard
/**
*一句话简单介绍类 a simple description of the class
*@author 类作者(最好增加联系方式) author name and contact info
*类全名:包名+类名 package name + class name
*@extends 类继承的类 the Parent class of the class
*@implements 类实现的接口 the implemented class of the class
*@Date 类编写日期 the class create time
*类编写思路: describe the useage of the class
*
编写类时的思路
*目前类处于的状态:比如首版,一次修改,两次修改,。。。,最终版
* the class status : e.g the first version, modified, final, final modified
*/
public class Demo {
/**
* 域注释
* 域用途解释
*/
private Object object;
/**
* 方法注释
* @param args 方法调用参数解释
*/
public static void main(String[] args) {
System.out.println("Hello, World.");
}
}