Android Studio添加文件注释头模板集合

最新推荐文章于 2024-06-15 05:44:34 发布

原创最新推荐文章于 2024-06-15 05:44:34 发布 · 427 阅读

1 ·

CC 4.0 BY-SA版权

Android 专栏收录该内容

19 篇文章

订阅专栏

本文详细介绍了如何在Android Studio中设置文件注释头模板，包括类注释、方法注释、文件注释等多个方面，提供了一步一步的操作步骤和各类型的模板内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Android Studio添加文件注释头模板集合

Android Studio中设置方式

File -> Settings -> Editor -> File and Code Templates -> 右侧File标签 -> Class,
模板填入如下内容：

一、类注释

/** 
* 
* @ProjectName: ${PROJECT_NAME}
* @Package: ${PACKAGE_NAME}
* @ClassName: ${NAME}
* @Description: java类作用描述 
* @Author: 唐朝
* @CreateDate: ${DATE} ${TIME}
* @UpdateUser: 更新者
* @UpdateDate: ${DATE} ${TIME}
* @UpdateRemark: 更新说明
* @Version: 1.0
*/

二、方法注释

/**
* @method $methodName$
* @description 描述一下方法的作用
* @date: $date$ $time$
* @author: 唐朝
* @param $param$
* @return $return$
*/

三、文件(Files)注释标签：

/** 
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author A18ccms A18ccms_gmail_com 
* @date ${date} ${time} 
* @version V1.0 
*/

四、类型(Types)注释标签（类的注释）：

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author A18ccms a18ccms_gmail_com 
* @date ${date} ${time} 
* 
* ${tags} 
*/

五、字段(Fields)注释标签：

/** 
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
 */

六、构造函数标签：

/** 
 * <p>Title: </p> 
 * <p>Description: </p> 
 * ${tags} 
 */

七、方法(Constructor & Methods)标签：

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param ${tags} 设定文件 
* @return ${return_type} 返回类型 
* @throws 
*/

八、覆盖方法(Overriding Methods)标签：

/* (非 Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/

九、代表方法(Delegate Methods)标签：

/** 
 * ${tags} 
 * ${see_to_target} 
 */

十、getter方法标签：

/** 
 * @return ${bare_field_name} 
 */

十一、 setter方法标签：

/** 
 * @param ${param} 要设置的 ${bare_field_name} 
 */

关于我

私人博客

技术微信公众号:infree6 或者直接扫码