idea文档注释入门

Java 文档注释

Java 支持三种注释方式。前两种分别是 ///* */,第三种被称作说明注释,它以 /** 开始,以 */结束。

说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。

说明注释,使你更加方便的记录你的程序信息。

1:在这里你想怎么修改怎么修改,点击使用Live Templates使用这个模板,以后创建什么文件都带有这些注释

idea文档注释入门

 

2:只在创建某个class时或者enum时或者Interface时自动添加这些注释,再点击使用这个模板

idea文档注释入门

 

3:idea导出html文档

导出文档方法:

在菜单栏选择Tools->Gerenate JavaDoc;

在弹出框内填写输出路径;

点击确认;

第一次可能会爆出中文乱码问题,下面是解决方法。

中文乱码解决方法:

在 Other command line arguments 中输入: -encoding utf-8 -charset utf-8