delphi的代码文档类似于javadoc或c＃xml doc [英] Code documentation for delphi similar to javadoc or c# xml doc

问题描述

我需要一个与javadoc或c＃xml doc相似的代码文档工具，用于delphi代码。什么是最好的工具？我更喜欢一种技术，这在未来与微软沙堡项目兼容。

I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project.

推荐答案

看看 SynProject ，一个用Delphi编写的开源工具。

Take a look at SynProject, an Open Source tool written in Delphi.

它旨在处理完整的文档工作流程，从规范到发行说明，包括测试，架构和设计;当然，还有一个集成的Delphi解析器，可以从现有的Delphi源代码生成架构文档。

It was designed to handle a full documentation workflow, from specifications to release notes, including tests, architecture and design; and of course there is an integrated Delphi parser to generate architecture documentation from existing Delphi source code.

对于架构文档，源代码可以提取注释（ala PasDoc）将此文本嵌入主体系结构文档（具有类层次结构图和单元依赖性）。

For the architecture document, the source code can extract comments (ala PasDoc) then embed this text into the main Architecture document (with class hierarchy diagrams and unit dependencies).

在专用文本编辑器中使用类似维基的语法编写纯文本文件然后SynProject从它创建良好的格式化Word文档。有些向导可用于访问内容。但是，由于它是作为普通文件存储的，所以使用任何SCM工具（SVN，Fossil ...）可以编写多个程序员。

You write a plain text file using a wiki-like syntax in a dedicated text editor, then SynProject creates well formated Word documents from it. Some Wizards are available to access the content. But since it's stored as plain file, multiple programmers can write on it, using any SCM tool (SVN, Fossil...).

例如，我目前使用它用于为一个庞大而旧的Delphi应用程序编写维护文档（大约有200万行代码写在Delphi 5和6中），没有以前提供的文档。您可以描述对代码所做的更改（引用单位/类/方法），然后该工具将更新所有文档以反映和跟踪这些修改。 SynProject旨在符合一些非常精细的规则规则（IEC 62304），但由于其独特的平面设计，可用于任何项目。

For instance, I currently use it for writing maintenance documentation for a huge and old Delphi application (about 2,000,000 lines of code written in Delphi 5 and 6), with no prior available documentation. You describe the changes made to the code (by quoting the unit/class/method), then the tool will update all documentations to reflect and trace those modifications. SynProject was designed to be compliant with some very "delicate" regulation rules (IEC 62304), but can be used for any project due to its unique "flat" design.

注意：我发布了这个问题很久以后，因为SynProject目前不存在，值得一看。此线程已被定义为该问题的参考。

Note: I'm posting this a long time after the question, because SynProject was not existing at this time, and can be worth looking at. This thread has been defined as a reference for that question.

这篇关于delphi的代码文档类似于javadoc或c＃xml doc的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！