微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

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

解决方法

看看 SynProject,一个用Delphi编写的开源工具.

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

对于体系结构文档,源代码可以提取注释(ala PasDoc),然后将此文本嵌入主体系结构文档(具有类层次结构图和单元依赖性).

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

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

注意:在这个问题之后我发布了很长时间,因为SynProject目前不存在,值得一看.这个线程has been defined as a reference for that question.

原文地址:https://www.jb51.cc/delphi/102838.html

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐