使用Doc-O-Matic（Express）和Delphi

Question

我正在寻找生成Delphi源代码文档的工具，我想试试Doc-O-Matic Express（免费）。是否有任何指导初学者如何使用Doc-O-Matic Express来记录Delphi源代码（管理doc-o-matic项目，首选docblock样式，完整的docblock语法等）？

Answer 1

现在不要使用Doc-o-matic设置。快递版仅限命令行。

1. 选择评论风格
2. 评论您的代码
3. 生成文档（默认项目足以启动）
4. 验证您的评论范围

Doc-o-matic支持JavaDoc和XMLDoc（甚至是各种原生注释）。只有当您的代码已经发表评论，或者您想直接在其IDE中发表评论时，该工具才会有所帮助。

  

如果您喜欢XML Doc或JavaDoc，   Doc-O-Matic同样支持两者   好的，这三种风格都是   撰写源评论时支持   通过综合编辑器回复   来源。

Answer 2

在这个page中，您可以找到一个对您有用的文档Delphi Documentation Guidelines。我使用此指南来记录此project中的源代码。