包机制 、JavaDoc
包机制
-
为了更好地组织类,Java提供了包机制,用于区别类名的命名空间。
-
包语句的语法格式为:
package pkg1[.pkg2[.pkg3...]];
-
一般利用公司域名倒置作为包名。
-
为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包,使用“import”语句即可完成此功能
import package1[.package2...].(classname|*);
JavaDoc
-
javadoc命令是用来生成自己API文档的
-
参数信息
-
@author 作者名
-
@version 版本号
-
@since 指明需要最早使用的jdk版本
-
@param 参数名
-
@return 返回值情况
-
@throws 异常抛出情况
-
operator.Doc
package com.shuang.base;
/**
* @author shuang
* @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;
}
}
通过命令行生成JavaDoc文档
- class 右键 Open In Explorer,打开资源管理器
- 资源管理器的文件命令行前加上cmd,进入dos命令模式
- 命令:javadoc -encoding UTF-8 -charset UTF-8 Doc.java //有警告,但是会生成
- 生成多个.html, 打开index.html
使用IDEA生成JavaDoc文档
- Tool s->Generate JavaDoc…
- Other command line arguments:-encoding UTF-8 -charset UTF-8 -windowtitle