使用word就可以，其中说明项目名称，单位时间写明项目结构，命名规范，发展进度，能考虑到的全放进来，告诉新人他现在要做的是什么，以后要做的是什么他会明白的。

要做java开发文档得做不少功夫，有需求规格说明书详细设计说明书软件功能规格说明书数据库设计说明书编码规范等比较重要的是 软件功能描述数据库设计编码规范，这样，及时有人员流动的话，新人看了文档，也能比。

如果你参与了项目，最好写清楚参与的项目的时间，项目描述，自己在这个项目中的主要责任，以及在项目中用到的技术和自己在项目中学到的东西 完成了xxx部分编码测试设计，在xxx时间内实现了yyyy功能，使得项目获得了zzzz。

Java语言提供了一种强大的注释形式文档注释可以将源代码里的文档注释提取成一份系统的API文档我们在开发中定义类方法时可以先添加文档注释，然后使用javadoc工具来生成自己的API文档文档注释以斜线后紧跟两个星号**。

先写修订的人 然后写这个项目是为了做什么的 然后用到的技术栈 然后详细介绍功能 如果是web项目就先介绍各个接口，需要的参数 然后如果时间允许，把几个重要的表 建模截图放进去。

对方法中某参数的说明@return 对方法的说明 对方法返回值的说明@exception 对方法的说明 对方法可能抛出的异常进行说明3命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来。

推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理一请求参数 1 请求方法 GET 用于获取数据 POST 用于更新数据，可与PUT互换，语义上PUT支持幂等 PUT 用于新增数据，可与POST互换。

1 调研结果需求分析说明书格式参照开发文档模板2 单位组织结构图功能模块分解图用VISIO绘制，或直接用WORD中的画图工具3 业务流程图用VISIO中的FLOWCHART模板绘制4 系统逻辑模型使用ROSE绘制活用VISIO中的。

自己百度“宿舍管理系统”设计方案详细设计，设计文档类似的关键字看看，这个和JAVA WEB没啥具体关系，javaweb只是它的表现形式你参考网上的文档，按照模版把项目基本内容填一下，功能方面你要的功能也就无非是quot入住quot。

20141006 求java项目开发具体流程，需求分析等 27 20120706 java项目分析 如何写 1 20200513 JAVA需求分析是什么 3 20180418 java web的项目需求怎么写？ 3 20090625 java 记事本需求分析该怎麽写呢？ 5 201。

用注释的方法写文档，别人难找，直接在项目里专门建一个Readme文件夹，然后里面放txt的说明文档，这方法土，但好用，但是做大的项目显然就行不通了，嘿嘿。

接口文档，代码层次比如公共方法写在哪个class里，哪些为一大类在一个包下，数据字典，就是介绍你这个项目的架构让后来的人怎么能容易参与开发，交接什么看这个就可以方便些，辅助作用的一个文档一般都是项目经理写。

2 设计和实现Java应用程序的架构Java开发人员需要根据需求分析和系统设计文档来设计和实现Java应用程序的架构，包括系统的组织结构模块的划分数据流程的设计等3 编写和执行单元测试和集成测试Java开发人员需要编写单元。

说明文档使用手册一般用doc至于楼上提到的 商圈排行榜 author xxx date Sep 4， 2008 102048 AM return 是用来给类或类中的方法写功能注释的，在 eclipse中，使用这个类或者类中的方法时，鼠标移到上面就会出现。

基本结构可以如下接口功能说明，参数返回结果定义，实例。