我正在试图弄清楚如何在ASP.NET项目中为单个c#文件自动生成文档。我正在使用VS 2010,我有SandCastle,但我开始觉得它只能用于一个完整的项目。问题是我们整个项目都很庞大,只有一个文件需要文档(它是我们客户使用的唯一功能 - 其他一切都是内部的)
我可以做一个批处理脚本,但是如果有更好的方法可以解决这个问题,我宁可不要这样做!
有人有什么想法吗?非常感谢提前!
(作为旁注,我已经看到了这一点并没有帮助:Generating XML Documentation for single VB Class in WebSite Project)
答案 0 :(得分:1)
我建议使用Sandcastle。
你可以做的一件事就是有一个post build任务,它从文档文件中提取XML的那部分,然后对你的新XML文件运行Sandcastle或doxygen。
答案 1 :(得分:0)
你试过StyleCop
吗?它的目的是确保一致的编码实践,但确实提供了一个方便的工具,允许您在构造函数,方法或属性等上快速“记录这个”。可能值得一看,看看它是否是你所追求的。
答案 2 :(得分:0)
Doxygen可能会有所帮助。 http://www.doxygen.nl/
至少你可以生成一个单词或pdf文档,然后只创建一个你需要提供的页面的子集。
答案 3 :(得分:0)
您可以尝试https://www.docify.net/。他们的全部内容就是这样。
答案 4 :(得分:0)
我最近创建了一个简单易用的库,它可以从C#代码生成markdown文档。所需要的只是一个类库dll文件。
如果您想尝试一下,here's a link如何开始使用生成的文档示例。
更多信息:https://www.nuget.org/packages/BetaSoftware.AutoDocumentation