人员流动是项目进行中比较让人头疼的事情。做好规范文档，可以让代码看起来比较像出自同一人之手。要做java开发文档得做不少功夫，有需求规格说明书、详细设计说明书、软件功能规格说明书、数据库设计说明书、编码规范等。比较重要的是 软件功能描述、数据库设计、编码规范，这样，及时有人员流动的话，新人看了文档，也能比较快的了解功能需求、数据库设计、编码规范，更快的上手项目。先看看你需要什么文档，然后去文库里搜索，就有相应的模板，找个适合自己项目的模板用。
1、【文档注释】是写在类或者方法的上面的。
文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。
使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。
之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。
2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。
3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。
扩展资料
java常用的文档注释标签
1、@author：标识一个类的作者
实例： @authordescription
2、@deprecated：指名一个过期的类或成员
实例： @deprecateddescription
3、@exception：标志一个类抛出的异常
实例：@exceptionexception-nameexplanation
4、{@inheritDoc}：从直接父类继承的注释
实例：Inheritsacommentfromtheimmediatesurperclass.
5、{@link}：插入一个到另一个主题的链接
实例：{@linknametext}
6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体
实例：Insertsanin-linelinktoanothertopic.
7、@param：说明一个方法的参数
实例：@paramparameter-nameexplanation
8、@return：说明返回值类型
实例：@returnexplanation
9、@see：指定一个到另一个主题的链接
实例：@seeanchor
10、@serial：说明一个序列化属性
实例：@serialdescription
参考资料：百度百科-java注释
java读取word文档时，虽然网上介绍了很多插件poi、java2Word、jacob、itext等等，poi无法读取格式(新的API估计行好像还在处于研发阶段，不太稳定，做项目不太敢用)；java2Word、jacob容易报错找不到注册，比较诡异，我曾经在不同的机器上试过，操作
方法完全一致，有的机器不报错，有的报错，去他们论坛找高人解决也说不出原因，项目部署用它有点玄；itxt好像写很方便但是我查了好久资料没有见到过关
于读的好办法。经过一番选择还是折中点采用rtf最好，毕竟rtf是开源格式，不需要借助任何插件，只需基本IO操作外加编码转换即可。rtf格式文件表
面看来和doc没啥区别，都可以用word打开，各种格式都可以设定。
![java中如何将byte[]里面的数据转换成十六进制？](/aiimages/java%E4%B8%AD%E5%A6%82%E4%BD%95%E5%B0%86byte%5B%5D%E9%87%8C%E9%9D%A2%E7%9A%84%E6%95%B0%E6%8D%AE%E8%BD%AC%E6%8D%A2%E6%88%90%E5%8D%81%E5%85%AD%E8%BF%9B%E5%88%B6%EF%BC%9F.png)
