Java项目文档

Question

我需要记录一个Java项目。我是C＃程序员和系统分析师。但我是Java的新手。

我有SVN检出的目录。

这些目录包括源目录，WEB-INF和其他文件对项目的定义要求，类路径等

据我所知，基本上文件都属于以下两种三类

1. 源代码基于软件包构造方式的文件/目录（.Java）
2. 项目定义，编译器设置等所需的目录/文件
3. 所需文件fo部署。

该项目（因为大多数Java项目都是）基于Eclipse的项目，该项目旨在托管在Tomcat上。

现在，你给上述信息，我已经决定了整个项目的文档分成三个不同的文件

1. 一个文件，解释的源代码等
2. 的文件解释文件&目录的目的是是编译器设置，项目定义等所必需的
3. 解释部署目录结构的文档。

或者我可以创建一个单独的文档，其中有三个部分可以解释上面的1-3。

现在，问题

1. 这是正确的做法？
2. 还有其他的方法可以追踪或借鉴吗？
3. 是否有任何其他建议等，您可以添加到这个方法

任何额外的信息会使用。

由于一吨提前

Answer 1

我认为你是在正确的轨道上。在一个项目中，您需要解决三个文档需要

1. 用户文档 这包括一份文件的应用程序是什么，以及如何启动/进入UT。

2. 开发文档 这包括至少Javadocs，源代码目录结构的描述，构建过程（即如何编译项目），编译器时间依赖性，开发标准，如何设置数据库用于开发，以及如何从存储库获取源代码。这些是让他人在您的项目中工作所需的最低限度。此外，随着项目复杂性的增加，我喜欢为系统中的常见任务制定一系列“如何”（例如：“如何为给定操作留下审计跟踪”，“如何使用日志框架”，“如何管理异常“等），主要域类及其关系的描述。如果您使用数据库，并且数据库模式不完全与域类一对一，我将添加模式文档。

3. 部署文档 这基本上是应用程序的安装手册，描述了使其运行所需的所有步骤：将WAR放在Tomcat中，对数据库运行脚本，需要修改的配置文件等等。

正如你所见，你已经部分解决了其中的两个问题。从小而简单的开始，并根据需要添加其余部分。

它还有助于检查您的组织是否有任何文档标准。

Answer 2

尝试Javadocs链接。写出适当的计划，它会解决你所有的问题。

Answer 3

甲文件，解释源代码等

是。就像你的读者是想要熟悉项目编写原因的人（为什么创建这个项目）以及项目的总体架构一样。

源类的Javadocs应解释每个类的作用。你的文档应该将Javadocs结合在一起，就像教程一样。

的文件解释文件&目录所必需的编译器设置，项目定义等

是目的。

解释部署目录结构的文档。

我想这就是你的构建脚本所做的。也许我不明白你期望这个文件能完成什么。

是否有任何其他建议等，您可以添加到这个方法

除非这是在你的开发小组第一次有人记录了一个Java项目，应该有其他文档。看看他们做了什么。

如果你是第一个，那么我会说这是一个好的开始。我会对第一份文件感兴趣。你的新程序员会喜欢第二个文档。