用于创建C#API和产品的良好文档的工具,方法和流程

发布时间：2020-12-16 05:44:47 所属栏目：百科来源：网络整理

导读：我们正在开发一个现在正在被“发布”的内部使用工具. 作为其中的一部分,我们想要记录该工具的功能,使用指南和代码API. 我以后是：允许从代码轻松地提取XML注释并转换为一个很好的布局文档的工具. 将代码示例和示例(MSDN样式)混合到#1中,还可以从代码生成文

我们正在开发一个现在正在被“发布”的内部使用工具.

作为其中的一部分,我们想要记录该工具的功能,使用指南和代码API.

我以后是：

>允许从代码轻松地提取XML注释并转换为一个很好的布局文档的工具.
>将代码示例和示例(MSDN样式)混合到#1中,还可以从代码生成文本(如实际产品的使用指南).
>创建图表(如分层架构和代码架构图以有条理和简单的方式).

我已经熟悉SandCastle等工具,可以将XML注释和编译成.chm文件,但这些工具似乎只生成方法/类注释的文档,无需在MSDN上插入示例和其他文本. .

此外,我想要一个工具,允许以“设计师样”的方式直观地添加图像(截图,图表).

我开始研究MS Office Publisher,不知道这是这个工作的正确工具.

我很乐意听到你的经验.

Doxygen允许您使用 dot或嵌入图像创建图表.代码示例很好我们将API文档编译成CHM文件.

更新：

Doxygen文档使用HTML类型的标记语言构建,并且没有可视化设计器.但是,它似乎拥有您所需的所有功能.

以下是我们嵌入示例XML文档的示例.我可以很容易地做一个代码示例：

还有一个屏幕截图,这个时候一页的图形和文字：

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!