首页 > 解决方案 > C# xmldoc 到文档页面

问题描述

我最近一直在将 Swagger 用于 WebAPI 项目,我喜欢文档及其包含的 XML 文档,我将其放在我的方法中。我有各种其他非 WebAPI 项目,我想为其生成文档。我知道 sandcastle 存在,并且我以前使用过它,但它不再维护。有一个叉子维护(叉子似乎对原来的变化不大)。此外,它不是地球上最“漂亮”的东西(或它产生的东西)。以前我使用了输出,谷歌很快就因为我不支持移动内容而降低了我的排名。

是否有任何其他文档生成器可以使现代网站在桌面和移动设备上很好地扩展?我只是被降级为手动制作文档吗?

这类似于如何从 XML 文档注释创建网站?但是,那是四年的历史,众所周知,四年内技术发生了很多变化。我正在寻找当前信息。

标签: c#xml-documentation

解决方案


DocFX 使得将生成的文档和手动文档结合起来变得非常容易

https://dotnet.github.io/docfx/

它是由微软开发的,用于替代 MSDN 文档门户,并开源。


推荐阅读