java入门07

Posted 2022-12-13 acrifhy

java入门07

包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。
• 包语句的语法格式：

package pkg1[.pkg2[.pkg3...]];

• 一般利用公司域名倒置作为包名；com.baidu.www
• 为了能够使用某一个包的成员，我们需要在java程序中明确导入该包。使用import语句来完成此功能

import package1[.package2...].(classname|*);

导入一个包下所有的类的方法:

import com.baidu.www.*;

推荐阿里巴巴java开发手册(代码规范)

https://github.com/alibaba/p3c/blob/master/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%EF%BC%88%E5%B5%A9%E5%B1%B1%E7%89%88%EF%BC%89.pdf

JavaDoc

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

jdk8帮助文档官方地址https://docs.oracle.com/javase/8/docs/api/

参数信息

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

写文档示例：

package base;

/**
 * @author srrdhy
 * @version 1.58
 * @since 8
 */
public class Doc 

    String name;

    /**
     *
     * @param name she
     * @return null
     * @throws Exception error
     */
    public String test(String name) throws Exception
        return name;
    

现在我们在文件夹里打开Doc（右击Doc点open in选Explorer），再用cmd打开，输入如下命令：

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

生成成功，我们发现文件夹多了一堆html文件

我们点击index.html

出现了与官方文档一样的版面，只不过我们的什么都没有

还可以通过IDEA生成javadoc文档，方法百度即可