c# - 为asp.net项目中的单个c#文件自动生成文档？

Question

我试图弄清楚如何为 ASP.NET 项目中的单个 c# 文件自动生成文档。我正在使用 VS 2010，并且我有 SandCastle，但我开始觉得它只能用于完整的项目。问题是我们的整个项目非常庞大，只有一个文件需要文档（这是唯一一个具有我们客户使用的功能的文件——其他一切都是内部的）

我可以做一个批处理脚本，但如果有更好的方法来解决这个问题，我宁愿不做！

有人有什么想法吗？首先十分感谢！

（作为旁注，我已经看到了这一点，但没有帮助：为 WebSite Project 中的单个 VB 类生成 XML 文档）

score 1 · Accepted Answer

我推荐使用沙堡。

你可以做的一件事是有一个后期构建任务，从文档文件中提取这部分 XML，然后针对你的新 XML 文件运行 Sandcastle 或 doxygen。

score 0 · Accepted Answer

你试过StyleCop吗？它更多地旨在确保一致的编码实践，但确实提供了一个方便的工具，允许您在构造函数、方法或属性等上快速“记录”。可能值得一看，看看它是否是您所追求的。

score 0 · Accepted Answer

多氧可能会有所帮助。 http://www.doxygen.nl/

至少您可以生成一个 word 或 pdf 文档，然后制作一个仅包含您需要提供的页面的子集。

score 0 · Accepted Answer

0

你可以试试https://www.docify.net/。他们的整个事情就是这样。

于 2016-07-18T21:48:49.523 回答

score 0 · Accepted Answer

我最近制作了一个简单易用的库，可以从 C# 代码生成 markdown 文档。所需要的只是一个类库 dll 文件。
如果您想尝试一下，这里有一个链接，说明如何开始使用它，并附有生成文档的示例。

5 回答 5