为项目中的单个 C# 文件自动生成文档 asp.net
本文关键字：自动生成 文档 asp net 文件 项目 单个 | 更新日期: 2023-09-27 18:34:04
我正在尝试弄清楚如何为 ASP.NET 项目中的单个 c# 文件自动生成文档。 我正在使用VS 2010，并且有SandCastle，但我开始觉得它只能用于整个项目。 问题是我们的整个项目都很大，除了一个文件需要文档之外什么都没有（它是唯一一个具有客户使用的功能的文件 - 其他一切都是内部的）
我可以做一个批处理脚本，但如果有更好的方法，我宁愿不做！
有人有什么想法吗？ 提前非常感谢！
（作为旁注，我已经看到了这个，但它没有帮助：为网站项目中的单个VB类生成XML文档）
我建议使用Sandcastle。
http://shfb.codeplex.com/
您可以做的一件事是有一个构建后任务，该任务从文档文件中提取 XML 的该部分，然后针对新的 XML 文件运行 Sandcastle 或 doxygen。
你试过StyleCop吗？它的目的更多的是确保一致的编码实践，但确实提供了一个方便的工具，允许您在构造函数、方法或属性等上快速"记录"。可能值得一看，看看它是否是你所追求的。
风格警察
你可以试试 https://www.docify.net/。他们的整个事情就是这样。
我最近制作了一个简单易用的库，可以从 C# 代码生成降价文档。只需要一个类库 dll 文件。
如果您想尝试一下，这里有一个关于如何开始使用它的链接，其中包含生成的文档示例。
更多信息 ： https://www.nuget.org/packages/BetaSoftware.AutoDocumentation
Doxygen可能会有所帮助。 http://www.doxygen.nl/
至少您可以生成一个单词或pdf文档，然后仅制作您需要提供的页面的子集。