学习任务:

视频学习注释模板

动手设置代码注释模板

动手导出导入模板

为了方便编写代码注释通过Eclipse可以设置代码注释模板,有了模板可以快捷的编写注释。

进入代码注释模板:

点击:window->preferences进入代码注释模板界面:

image-20210108160606373

一个程序代码中有很多地方需要写注释,比如:关于类的注释、成员变量注释、方法注释等。

下边给出编写注释模板的例子:

1、类注释

/**
 * ${todo}(说明此类的作用)
 * @author 攀博课堂
 * @version v1.0
 * ${date} ${time}
 */

image-20210108160726951

2、构造方法注释

/**
 * ${todo}(说明此构造方法的作用).
 * ${tags}
 * @author 攀博课堂
 * @version v1.0
 * ${date} ${time}
 */

image-20210108160956233

3、普通方法 注释

/**
 * ${todo}(说明此方法的作用).
 * ${tags}
 * @author 攀博课堂
 * @version v1.0
 * ${date} ${time}
 */

image-20210108161255100

Eclipse提供了编写注释的变量:

1、${year},代表当前年份,例如:2021
2、${date},代表当前日期,例如:2021年1月1日
3、${time},代表当前时间,例如:下午13:00:00
4、${project_name},代表项目名
5、${package_name},代表包名
6、${file_name},代表当前文件名
7、${type_name},代表当前类名
9、${tags},输出函数的输入参数与返回值
10、${todo},生成一个TODO标签,可通过eclipse的Tasks查看
11、${user},当前操作系统的用户名

当模板配置好后可以导出到电脑上保存,一旦更换了eclipse就可以导入。

导出:

image-20210108203546440

image-20210108203555003

注释模板导出后保存为codetemplates.xml文件到自己的电脑上。

导入模板:

当更换了新的环境,无需手动一个一个配置直接导入模板即可使用。

image-20210108203657325

点击 Import,选择注释模板文件,导入成功。

提问-攀博课堂
我要提问 不会就问,有效沟通
关注公众号,加入微信群交流提问。 攀博课堂官方公众号
问答列表,查看本知识点所有问题