Java 类注释模板

最新推荐文章于 2025-09-24 01:18:53 发布

原创最新推荐文章于 2025-09-24 01:18:53 发布 · 685 阅读

0 ·

CC 4.0 BY-SA版权

Java 专栏收录该内容

12 篇文章

订阅专栏

本文介绍了一种用于软件开发过程中的代码模板规范，包括文件、类及方法级别的注释模板。这些模板有助于统一代码风格，提高代码可读性和维护性。

文件模板：

/**
 *
 * FileName:   [${file_name}]
 * Copyright:  [Copyright information]
 * Describtion:[A phrase to describe the class]
 * @Author:    [${user}]
 * @CreateDate:[${date}]
 *
 */

类模板：

/**   
 * Simple to introduction
 * @ProjectName:  [${project_name}]
 * @Package:      [${package_name}.${file_name}]
 * @ClassName:    [${type_name}]
 * @Description:  [A phrase to describe the class]
 * @Author:       [${user}]
 * @CreateDate:   [${date}]
 * @UpdateUser:   [${user}]
 * @UpdateDate:   [${date}]
 * @UpdateRemark: [The content of this revision]
 * @See           [Related classes and methods]
 * @Since         [Product template version]  
 * @Version:      [v1.0]
 *    
 */

方法模板：

/**
 * @MethodName: [${enclosing_method}]
 * @Description:[A phrase to describe the method]
 * @Author:     [${user}]
 * @CreateDate: [${date}]
 * @Params:     [ParamType ParamValue,ParamType ParamValue...]
 * @See         [Related classes and methods]
 * @Since       [Product template version]  
 * @Return:     [${return_type}]
 * @Throws:     [Exception]
 *
 */