一般用公司域名倒置作为包名:如百度网址www.baidu.com,包命名为com.baidu.www(com.yang),下面我们就来聊聊关于java包结构的规范性知识?接下来我们就一起去了解一下吧!
java包结构的规范性知识
包机制一般用公司域名倒置作为包名:如百度网址www.baidu.com,包命名为com.baidu.www(com.yang)
包必须在类的最上面,导入包使用语句import package 包名.(是通配符代表包名下所有内容)
搜索:百度搜阿里巴巴开发手册学习Java基础
JavaDocJavaDoc命令是用来生成自己API文档的
jdk帮助文档(浏览器搜索)
//参数信息
@author 作者名
@version 版本号
@since 需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况
选择类右键选Show in explorer可进入类存储地址,在类地址前进入cmd,并输入javadoc -encoding UTF-8 -charset UTF-8 类名.java,执行后会在类存储地址生成index.html文件,点开之后是我们自己写的类的帮助文档说明
idea生成Javadoc文档
- 首先新建一个文件夹,用来专门存放Javadoc文档
- 打开idea选择要生成文档的代码
- 选择之后就看idea的顶部有一个Tools的菜单,选择Generate JavaDoc这个选项
- 然后会弹出一个界面,然后在Output directory 输入框后面的按钮点击进去选择刚才创建的文件夹
- 然后在下面的locale框中输入zh_CN,这个代表的就是中文,输完之后在locale下面的框中输入-encoding utf-8 -charset utf-8
- 最后点击ok,等待文件生成完毕之后,执行后会在JavaDoc文件夹生成index.html文件,点开之后是我们自己写的类的帮助文档说明