代码整洁,规范,可读,注释是关键之一。
1.整个类文件注释
注释结构:
/*
* @(#){类名称}.java {创建时间}
*
* {某人或某公司具有完全的版权}
* {使用者必须经过许可}
*/
2. 具体类功能注释
注释结构:
/**
* 类 <code>{类名称}</code>{此类功能描述}
*
* @author {作者}
* @version {版本,常用时间代替}
* @see java.lang.Class
* @since JDK{jdk版本}
*/
public class Object {}
3. 类变量注释
注释结构:
/** {此值是用来存储/记录什么的}*/
private String str ;
4. 类方法注释
注释结构:
/**
* {方法的功能/动作描述}
*
* @param {引入参数名} {引入参数说明}
* @return {返回参数名} {返回参数说明}
* @exception {说明在某情况下,将发生什么异常}
*/
public String substring(int beginIndex) {
return substring(beginIndex, count);
}
5. 类方法中代码块注释
注释结构:
/*
* {功能描述}
*
* {具体实现动作}
*/
时间: 2024-10-10 05:59:12