如何使用idea生成java的doc文档
/**和 */ 是java所特有的文档注释,这些注释用说明类的用途、方法的操作、参数的含义等
*注意:文档注释必须放在 方法声明的前面,不能放在方法中
代码示例:
package experimentseven;
//package experimentseven;
//XbShiYan7_7.java
/**
这个程序定义了一个XbShiYan7_7,类中有一个公共属性,两个私有属性和七个方法,
可以调用introduce()方法,显示学生的姓名、年龄、系别。
*<br>@author Jame_Wei
*<br>Date:2020-05-26
*<br>@version2.3
*<br>@since JDK 10
*/
public class XbShiYan7_7 {
/**
* 私有属性name,字符串型
*/
private String name;
/**
* 私有属性age,整数型
*/
private int age;
/**
* 公共属性dept,字符串型
*/
public String dept;
/**
* 公共方法,设置name的属性
*
* @param newName 接收姓名
*/
public void setName(String newName) {
name = newName;
}
/**
* 公共方法,返回name属性
*
* @return姓名
*/
public String getName()
{
return name;
}
/**公共方法,设置name的属性
*
* @param newAge 年龄参数
*/
public void setAge(int newAge)
{
age=newAge;
}
/**公共方法,返回age属性
*
* @return 年龄
*/
public int getAge()
{
return age;
}
/**公共方法,设置dept属性
*
* @param newDept 系别参数
*/
public void setDept(String newDept)
{
dept=newDept;
}
/**公共方法,返回dept属性
*
* @return 系别
*/
public String getDept()
{
return dept;
}
/**公共方法,显示各个属性的值
*/
public void intrduce()
{
System.out.println("我的名字是"+getName());
System.out.println("我的年龄是"+getAge());
System.out.println("我的系别是"+getDept());
}
}
操作第一步:
第二步:
注意:
第一个框:文档输出的路径
第二个框: Locale 选择地区,决定文档的语言,中文是zh_CN
第三个框: 传入JavaDoc的参数,一般这样写:
-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
简单操作完,打开doc文档所在文件夹,出现了一堆东西。
我也不知道是啥?但主要的就是要找到以java文件名命名的html文档。
到了这里就可以随意点击查看了,索引挺好用的,可以直接看到包名,类名,方法名
到这里,就完成了( 。◕ˇ∀ˇ◕。),欢迎点赞、评论、关注。