Ada軟件的文檔工具

Question

簡介：我正在尋找某種工具來根據現有軟件源代碼中的註釋生成軟件描述。

詳細信息：我已經有用Ada編寫的現有源代碼。需要對源代碼進行更改，並且還需要生成一個文檔，其中包含整個軟件及其所有軟件包，例程等的描述（如果可能，則爲PDF）。對於現有的例程，這些源代碼註釋已經存在並且包含足夠的細節以滿足我的需求。

該說明應包括至少

• 整體軟件設計
• 的軟件包，例行程序，變量，常量等
• 通話和來電圖

對於基於項目的文字說明在C上我會使用Doxygen做到這一點。然而，Doxygen本身並不適應用Ada編寫的軟件。我的想法是（自動）轉換源代碼中的現有註釋，以便Doxygen可以讀取這些註釋。轉換本身沒有問題（使用Doxygen的過濾機制），但由於C和Ada之間的關鍵字和語法有很大差異，所以這並沒有產生任何可用的輸出。

然後我看了一下SciTools的瞭解。雖然這個軟件分析了一個很好的細節並且生成了很好的矩陣，但是我無法從中得到任何東西，這與我需要的文檔類似。

我想避免（手動）編寫單獨的文檔，而是想從代碼庫中生成此文件。無論如何，我將不得不提供所有必要的信息（或許除總體概述外），那麼爲什麼不將它用於文檔目的。

有什麼工具可以做我需要的嗎？

Answer 1

有一個名爲「AdaDoc」的工具，它似乎做了你所要求的一部分。你當然可以使用「a2ps」作爲你需求的文本部分（我比AdaDoc產生的更好）。

有幾個UML工具（「Umbrello」是我記憶中的一個名稱），它提供了創建包間關係的圖表，但對於規模較大的項目，最好的選擇是使用原始設計文檔，只需驗證源文本是否與該設計實際相符即可。