包机制和JavaDoc生成

包机制用途及用法

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

一般利用公司域名倒置作为包名;列如www.baidu.com 开发的时候包名就为com.baidu.www

为了能够使用某一个包的成员,在Java程序中明确导入该包,使用import语句

类中 package位置语句必须在最上面

后面import引入的类都必须在其下面

import com.abiao.www.base.project2; //用这样的方式导入
    import com.abiao.www.base.*;//导入这个包下所有的类

JavaDoc命令的用途

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

可以在文档注释里使用的参数信息有

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

不过要注意的是文档注释加在类上面就是类注释,加在方法上面就是方法注释

使用CMD导出JAVADOC的办法:

  • 在IDEA中选中该类在文件中打开

  • 进入文件夹后在地址栏输入cmd+空格

  • 进入cmd输入

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

ps:我不知道为什么我输出不了

其次是使用IDEA输出:

  • 在IDEA菜单栏中找到 Tools -Generate JavaDoc 进入下面页面

    包机制和JavaDoc生成

解释:

  • 1是选择是整个项目还是模块还是单个文件

  • 2是文档输出路径

  • 3是Locale 选择地区,这个决定了文档的语言,中文就是zh_CN

  • 4是传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8

上一篇:004-Java注解-@Documented


下一篇:Java基础语法(运算符、命名规范)