CODE Delphi的文档创建工具 [英] CODE Documentation creation tool for Delphi

问题描述

可能重复：

类似于javadoc或c＃xml doc的delphi的代码文档

我想开始记录一个非常大的Delphi应用程序，目前它没有任何文档。我的同事建议使用javadoc类型的文档样式，因为我们可以运行一个自动化程序来创建可搜索和漂亮的漂亮文档。

 （*功能描述
 @param S某些字符串
 @param索引字符串索引s 
 @retval TRUE条件是真的
 @retval FALSE否则
 @see IndexOf 
 @see排序
 @see排序
 *）
 bool Stringlist :: Find（const char * S，int& Index）
 {
 [...] 
} 
  / pre> 
 
 
这是我可以为我的项目完成有意义的文档的最好方法吗？如果是这样，那么一个很好的程序来处理这些类型的注释。到目前为止，我已经向我推荐了 Doc-O-Matic 。
 
 
 
如果是任何使用程序是非常老的，它已经不断发展自1993年以来，已经经历了许多不同的作者，许多不同的风格，IDE，标准等。 p> 
 
解决方案
看看 SynProject ，一个用Delphi编写的开源工具。
 
 
 
它旨在处理从规范到发行说明的完整文档工作流程，包括测试，架构和设计;当然，还有一个集成的Delphi解析器，可以从现有的Delphi源代码生成架构文档。
 
 
 
对于架构文档，源代码可以提取注释（ala JavaDoc）将此文本嵌入主体系结构文档（具有类层次结构图和单元依赖性）。
 
 
 
在专用文本编辑器中使用类似维基的语法编写纯文本文件然后SynProject从它创建良好的格式化Word文档。有些向导可用于访问内容。但是，由于它是作为普通文件存储的，所以使用任何SCM工具（SVN，Fossil ...）可以编写多个程序员。
 
 
 
例如，我目前使用它用于为一个庞大而旧的Delphi应用程序编写维护文档（大约有200万行代码写在Delphi 5和6中），没有以前提供的文档。您可以描述对代码所做的更改（引用单位/类/方法），然后该工具将更新所有文档以反映和跟踪这些修改。 SynProject旨在符合一些非常精细的规则规则（IEC 62304），但由于其独特的平面设计，可用于任何项目。
 

  
Possible Duplicate:

  Code documentation for delphi similar to javadoc or c# xml doc  
I want to start documenting a very large Delphi application, which currently has no documentation whatsoever.  My coworker suggested a javadoc type documentation style because we can then run an automated program to create nice documentation which is searchable and looks pretty.  
(* Description of the function            
 @param S        some string
 @param Index    the index of string s
 @retval TRUE    condition where it is true
 @retval FALSE   otherwise.
 @see            IndexOf
 @see            Sort
 @see            Sorted
*)
bool Stringlist::Find(const char *S, int &Index)
{
   [...]
}
Is this the best way I can accomplish meaningfull documentation for my project?  If so what is a good program to handle these types of comments .  So far I have had Doc-O-Matic recommended to me.

If it is any use the program is very old, it has been constantly developed since 1993 or so and has gone though many different authors, many different styles, IDEs, standards, etc.
解决方案
Take a look at SynProject, an Open Source tool written in 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.

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

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...).

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.

                        
这篇关于CODE Delphi的文档创建工具的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！