多种Java头文件注释的常用模板解读

/**
 * 类描述信息
 * 
 * @author 作者名
 * @date ${DATE}
 * @version 1.0
 */
public class ClassName {
    // 类内容
}

/**
 * @ClassName: ClassName
 * @Description: 类功能详细描述
 *        可以多行描述
 * @author: 作者名
 * @date: ${YEAR}-${MONTH}-${DAY}
 * @version: 1.0.0
 * @since: 1.8
 * @deprecated: false
 */
public class ClassName {
    // 类内容
}

/**
 * Copyright © ${YEAR} 公司名称. All rights reserved.
 *
 * @ProjectName: 项目名称
 * @Package: com.xxx.xxx
 * @ClassName: ClassName
 * @Description: 类描述
 * @author: 作者名
 * @date: ${YEAR}-${MONTH}-${DAY} ${TIME}
 * @version: V1.0
 */
public class ClassName {
    // 类内容
}

/**
 * 方法功能描述
 *
 * @param param1 参数1描述
 * @param param2 参数2描述
 * @return 返回值描述
 * @throws ExceptionType 异常描述
 */
public ReturnType methodName(ParamType param1, ParamType param2) {
    // 方法体
}

Abbreviation: header
Description: 文件头注释
Template text: 
/**
 * @Description: $DESCRIPTION$
 * @author: $USER$
 * @date: $DATE$ $TIME$
 * @version: 1.0
 */

/**
 * 订单服务类
 * <p>负责订单的创建、查询、修改等操作</p>
 *
 * @author ZhangSan
 * @date 2024-01-15
 * @version 1.0.1
 * @since JDK 1.8
 * @see OrderDao
 * @see OrderVO
 */
public class OrderService {
    // 类内容
}