Ada软件的文档工具

时间:2017-07-31 09:46:04

标签: ada documentation-generation

简介:我正在寻找某种工具来从现有软件源代码中的注释中生成软件描述。

更详细:我已经用Ada编写了现有的源代码。需要对此源代码进行更改,我还需要生成一个文档,其中包含整个软件的描述以及所有软件包,例程等(如果可能的话,以PDF格式表示)。对于现有的例程,这些源代码注释已经存在,并且包含了满足我需求的足够详细信息。

描述至少应包括

  • 整体软件设计
  • 包,例程,变量,常量等的文本描述。
  • 来电和来电图

对于基于C的项目我会使用Doxygen执行此操作。然而,Doxygen本身并不能应对用Ada编写的软件。我的想法是(自动)转换源代码中的现有注释,以便Doxygen可以读取这些。转换本身没问题(使用Doxygen的过滤机制),但由于C和Ada之间的关键字和语法差异很大,因此不会产生任何可用的输出。

然后我看了一下SciTools的理解。虽然这会将软件分析到一个很好的细节并生成很好的metrices,但我无法从中得到任何东西,它类似于我需要的文档。

我想避免(手动)编写单独的文档,而是希望从代码库中生成它。无论如何,我将不得不提供所有必要的信息(可能除了概述之外),所以为什么不将它用于文档目的。

是否有任何工具能够满足我的需求?

2 个答案:

答案 0 :(得分:3)

有一个名为" AdaDoc"的工具,它似乎是你所要求的一部分。你当然可以使用" a2ps"对于你需要的文本部分(我比AdaDoc生成的更好)。

有几个UML工具(" Umbrello"是我记得的一个名字),它提供了创建包间关系的图形,但对于一个规模很大的项目,最好的选择是使用原始设计文档,并简单地验证源文本是否与该设计实际匹配。

答案 1 :(得分:2)

对于Doxygen不支持的语言,我已经编写了自己的“通用”过滤器。 这是非常基本的,但对我有用。 https://github.com/malkev/doxphp