asp.net – 文档生成 – 我应该选择哪些框？

发布时间：2020-12-16 10:00:07 所属栏目：asp.Net 来源：网络整理

导读：我正在考虑要求我的团队为一些重要的即将到来的项目更彻底地记录他们的代码,并使生活变得少一些痛苦,我正在转向 XML文档生成器,如 Sandcastle,Doxygen或 Box Live Documenter. 在评估最佳选择时,我应该记住哪些关键考虑因素以及哪些经验使您做出特定决定？

我正在考虑要求我的团队为一些重要的即将到来的项目更彻底地记录他们的代码,并使生活变得少一些痛苦,我正在转向 XML文档生成器,如 Sandcastle,Doxygen或 Box Live Documenter.

在评估最佳选择时,我应该记住哪些关键考虑因素以及哪些经验使您做出特定决定？

解决方法

对我来说,关键考虑因素是：

>完全自动化：它可以以这样的方式设置,以便相当多
不需要外面的工作
创建或编辑文档.
>完全风格：文档可以完全样式化
它在wiki或pdf中看起来很棒
在它生成之后.我应该
能够改变颜色,字体大小,
布局等
>良好的过滤：我可以只选择我想要的项目
产生.我应该可以
过滤命名空间,文件类型,
课程等
>自定义：我可以包含页眉,页脚,自定义元素,
等等

我发现Doxygen可以做到这一切.我们的工作流程如下：

>开发人员对代码进行了更改
>他们在刚更改的代码正上方更新文档标记
>我们点击一??个生成按钮

然后,Doxygen将从代码中提取所有XML文档,将其过滤为仅包含我们想要的类和方法,并应用我们为其预先制作的CSS样式.我们的最终结果是内部维基,它看起来像我们想要的方式,不需要编辑.

额外：我们??在各种git存储库中拥有所有项目.我们将所有这些下拉到一个根文件夹,并从此根文件夹生成文档.

有兴趣知道其他人如何进一步自动化……？

（编辑：李大同）

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