目录
- 包机制
- JavaDoc生成文档
- 方法一
- 方法二
包机制
- 为了更好的组织类,Java提供了包机制,用于区别类名的命名空间;
- 包语句的语法格式为:package pkg1[. pkg2[. pkg3 …]];
- 一般利用公司的域名倒置作为包名;com.baidu.com
- 为了能够使用某一包的成员,需要在Java中明确导入该包。使用“import”语句可以导入包;
- 包的本质就是一个文件夹;为的是不重名;
- 创建以后不分级显示,需要设置,取消勾选就可以了;
JavaDoc生成文档
- javadoc命令是用来生成自己的API文档;
- 参数信息:
- @author作者名
- @version版本号
- @since指明需要最早使用的jdk版本
- @param参数名
- @return返回值情况
- @throws异常抛出情况
package com.java.operator;
/**
* @author dl
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
方法一
首先打开源文件的地址;
打开以后在上方输入cmd+空格
;
然后输入命令javadoc -encoding UTF-8 -charset UTF-8 Doc.java
;-encoding
代表编码方式, -charset
代表字符集。让文章不出现乱码;
打开index.html;
方法二
(选中要生成文档的类)找到工具栏tools --> Gencrate JavaDoc…打开;
1.选择深成文档范围(也可以选中要生成的文档类);2. 生成文件存放的位置;3.语言:中文:zh_CN;4. 输入-encoding UTF-8 -charset UTF-8,避免出现乱码。注意:java文件路径没有中文,存放JavaDoc文档的目录路径也没有中文,否则会出现报错;
成功生成;