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項目，應該有其他文檔。看看他們做了什麼。

如果你是第一個，那麼我會說這是一個好的開始。我會對第一份文件感興趣。你的新程序員會喜歡第二個文檔。