Java基础 包机制和注释文档
一、包机制
为了便于类包的管理和命名冲突建立的文件夹
1.建包 Package
命名规范：
package package1.package2.package3.(类名)……注意事项：
-
建立公司的包时，要严格遵守域名倒置 例如：com.baidu.www
-
package语句要写在最顶端
2.导包 import
命名规范：
import java.lang.date.(类名)……注意事项：
import语句要写在package语句之下，类的外面
二、注释文档
Java支持单行注释、多行注释和注释文档
注释文档是用于在程序内生成关于程序的信息，使程序员更方便的记录程序的信息
1.注释文档的基本参数
写在类的外部
/**
// 注释文档
@author Wavesboker //作者名
@version //版本号
@since //开发用的Java版本
@param //参数名
@return //返回值
@throws //异常抛出情况 */
写在方法内
public class Demo10 { String name;
/** *
@param name
@return
@throws Exception //抛出异常 */
public String Test(String name) throws Exception{ return name;
}
2.使用命令行生成doc文件
在文件夹内打开cmd
命令行内使用javadoc指令生成API文档
-encoding UTF-8 将编码格式输出为UTF - 8 以免因中文产生乱码
-charset UTF -8 将字符集编码格式也改成UTF-8
Demo1.java 选择生成doc信息的文件
3.使用IDEA软件生成Doc文档
选择Tools > Generate Javadoc
按步骤设置 > 点击OK
