前言：
如今我们对“java项目文档怎么写”可能比较讲究，小伙伴们都需要知道一些“java项目文档怎么写”的相关知识。那么小编在网络上搜集了一些有关“java项目文档怎么写””的相关文章，希望咱们能喜欢，姐妹们一起来了解一下吧！包机制
一般用公司域名倒置作为包名：如百度网址,包命名为com.baidu.www(com.yang)
包必须在类的最上面，导入包使用语句import package 包名.(是通配符代表包名下所有内容)
搜索：百度搜阿里巴巴开发手册学习Java基础
JavaDoc
JavaDoc命令是用来生成自己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文件，点开之后是我们自己写的类的帮助文档说明
版权声明：
本站文章均来自互联网搜集，如有侵犯您的权益，请联系我们删除，谢谢。
标签： #java项目文档怎么写 #java引入包 #怎么用java创建文件 #java生成执行文件 #java创建文件夹并写入文件
