包机制//JavaDoc

最新推荐文章于 2024-06-06 23:14:26 发布

Niangao9527

最新推荐文章于 2024-06-06 23:14:26 发布

阅读量234

点赞数

分类专栏：小白学习日记文章标签： linq microsoft c#

本文链接：https://blog.csdn.net/Niangao9527/article/details/122325214

版权

小白学习日记专栏收录该内容

12 篇文章 0 订阅

订阅专栏

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

包语句的语法为：

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

一般利用公司域名倒置作为包名：com.baidu.www、com.alibaba.www

为了能够使用某一个包的成员，我们需要在java程序中明确导入该包。

使用“import”语句可完成此功能： * 是通配符，可导入某个包下所有的类

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

JavaDoc：

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

参数信息：

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

package com.you.base.operator;

/**
 * @author youshen
 * @version 1.0
 * @since 1.8
 */

public class Doc {
    String name;

    /**
     * @author youshen
     * @param name
     * @return 00
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return  name;
        //以上是由命令行生成的   javadoc 参数 java文件

        //作业（必须完成）：学会查找使用IDEA生成JavaDoc文档！   自己在网上查找解决
    }
}

文档地址上输入：cmd+空格+回车进入文档所在的命令提示符；或 Win+R 快捷键进入。

进入Doc参数后输入：javadoc -encoding UTF-8 -charset UTF-8 Doc.java 再回车完成

作业：使用IDEA生成JavaDoc文档！

新建个项目：

/**
 * @author 游神
 * @version 1.0
 * @since 1.8
 */

public class JavaDoc {
    String name;

    /**
     * @author 游神
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

}

之后再点击进入Tools--->Generate JavaDoc界面；

文档地址选择标注清楚；

Locale选择地区，中文就是：zh_CN；

JavaDoc参数：-encoding UTF-8 -charset UTF-8；

最后点击OK完成！