java项目代码说明文档,大学生java项目说明文档

在java项目里面写说明文档，用什么格式的呀

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

相关问答

Q1: java项目做完怎么写说明文档

如果你参与了项目，最好写清楚参与的项目的时间，项目描述，自己在这个项目中的主要责任，以及在项目中用到的技术和自己在项目中学到的东西

完成了xxx部分编码/测试/设计，(在xxx时间内)实现了yyyy功能，使得项目获得了zzzz收益，获得dddd奖励。

可以在项目描述中谈谈自己在实现某项功能时用到了什么技术，如用MySQL的 limit语句实现分页功能

先介绍一下项目要实现的功能，在介绍下程序的结构划分(MVC),再谈下MVC各是用什么技术实现的(如View用了JSP、JSTL,Controller使用Struts2的过滤器。。。)，然后介绍下实现主要功能时具体用了哪些技术(建议你多谈点对AJAX的理解)

Q2: java项目 代码结构说明书怎么写

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

Q3: 做完JAVA项目后，要求写一份DOC技术文档说明这个项目，怎么写？

先写修订的人

然后写这个项目是为了做什么的

然后用到的技术栈

然后详细介绍功能 如果是web项目就先介绍各个接口,需要的参数

然后如果时间允许,把几个重要的表 建模截图放进去