Ada软件的文档工具

Ada软件的文档工具,ada,documentation-generation,Ada,Documentation Generation,简介:我正在寻找某种工具,根据现有软件源代码中的注释生成软件描述 更详细地说:我已经用Ada编写了现有的源代码。需要对此源代码进行更改,我还需要生成一个文档,其中包含对整个软件及其所有包、例程等的描述(如果可能,为PDF格式)。对于现有的例程,这些源代码注释已经存在,并且包含足够的细节以满足我的需要 说明应至少包括: 软件总体设计 包、例程、变量、常量等的文本描述 调用和调用图 对于基于C的项目,我会使用Doxygen来完成这项工作。然而,Doxygen本身不能处理用Ada编写的sotwar

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

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

说明应至少包括:

  • 软件总体设计
  • 包、例程、变量、常量等的文本描述
  • 调用和调用图
对于基于C的项目,我会使用Doxygen来完成这项工作。然而,Doxygen本身不能处理用Ada编写的sotware。我的想法是(自动)转换源代码中的现有注释,以便Doxygen可以读取这些注释。转换本身没有问题(使用Doxygen的过滤机制),但是由于C和Ada之间的关键字和语法有很大不同,因此没有产生任何可用的输出

然后我看了一看SciTools的理解。虽然这对软件进行了很好的详细分析,并生成了很好的度量值,但我无法从中得到任何东西,这与我需要的文档类似

我希望避免(手动)编写单独的文档,而是希望从代码库生成此文档。无论如何,我必须把所有必要的信息(也许除了一般概述)放在那个里,所以为什么不把它也用于文档目的呢

有什么工具可以满足我的需要吗?

有一个叫做“AdaDoc”的工具,它似乎可以满足你的部分需求。当然,您可以将“A2P”用于您需求的文本部分(我更喜欢它,而不是AdaDoc生成的内容)

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

有一种称为“AdaDoc”的工具,这似乎是你要求的一部分。当然,您可以将“A2P”用于您需求的文本部分(我更喜欢它,而不是AdaDoc生成的内容)


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

对于Doxygen不支持的语言,我已经编写了自己的“通用”过滤器。 这很基本,但对我很有用。

对于Doxygen不支持的语言,我编写了自己的“通用”过滤器。 这很基本,但对我很有用。

你的问题在这里是离题的。试着问一下,试着在谷歌上搜索
doxygenada
如果你正在使用gnat,有
gnatdoc
我们不打算使用gnat。。。但是:我目前正在测试AdaBrowse,它看起来很有希望,而且还需要安装GNAT。你的问题在这里是离题的。试着问一下,试着在谷歌上搜索
doxygenada
如果你正在使用gnat,有
gnatdoc
我们不打算使用gnat。。。但是:我目前正在测试AdaBrowse,它看起来很有希望,而且还需要安装GNAT。