包机制与JavaDoc命令

包机制与JavaDoc命令

包机制

为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。

一般利用公司域名导致作为包名：

例如：com.baidu.www

为了能够使用某一个包的成员，我们需要在java程序中明确导入该报，使用’import’语句完成此功能。

注意：

包的名字尽量不要重复。

JavaDoc命令

JAVA1.8API英文文档

这个是JAVA1.8的API文档，供各位查找API时使用。

JavaDoc命令

javadoc命令是用来生成自己的API文档的

参数信息：

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的JDK版本
• @param 参数名
• @return 返回值的情况
• @throws 异常抛出情况

package Wyw;
/**
*@author Wyw
*@version   1.0
*@since   1.8
*/
public class Doc {

	String name;
	/**
	 * 
	 * @param name
	 * @throws Exception
	 */
	public void name(String name)throws Exception {
		
	}
}

加在类上就是类的注释，加在方法上面就是方法注释。

进入你的JAVA所在的文件夹并且在自己的命令提示符里面

输入下面的代码：

javadoc -encoding UTF-8 （编码格式选择 UTF-8）-charset UTF-8（字符串格式选择 UTF-8） Doc.java（最后是你自己的文件名哦！）

上面输入之后（）里面的内容要全部删掉哦！

就会生成属于你一个人的文档注释了

拓展

IDEA生成JavaDoc文档