使用visual studio和sandcastle在C＃中创建文档 [英] Creating documentation in C# using visual studio and sandcastle

问题描述

什么是VS项目文档的更新。 Sand Castle仍然是常态，还是有另外一个更好的工具用于文档？

Whats the update on documentation for VS projects. Is Sand Castle still the norm, or is there another better tool out there for documentation?

推荐答案

在我可用的免费解决方案Sand Castle是常态，我可以建议 Sandcastle帮助文件生成器：

GitHub - EWSoftware / SHFB：Sandcastle帮助文件生成器（ SHFB）。独立的GUI，Visual Studio集成包和MSBuild任务，提供使用Sandcastle工具构建帮助文件的完整配置和可扩展性。 [ ^ ]



过去我使用了 NDoc 这很好但很遗憾没有针对较新的.NET Framework版本定期更新。

HelpNDoc 似乎很有希望，但没有成功生成大型解决方案的文档：

< a href =http://www.helpndoc.com/> HelpNDoc | HTML帮助创作工具，Word，PDF和eBook文档生成器 [ ^ ]

Of the free solutions available for me Sand Castle is the norm, I can recommend Sandcastle Help File Builder:
GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.[^]

In the past I used NDoc which was nice but sadly not regularly updated for newer .NET Framework versions.
HelpNDoc seemed promising, but didn't succesfully generate documentation for a large solution:
HelpNDoc | HTML help authoring tool, Word, PDF and eBook documentation generator[^]

目前我选择了两个工具用于在Visual Studio 2015中的项目中记录和注释代码 - Sandcastle和GhostDoc。



Sandcastle不断发展，是一个非常强大的工具。它是免费和开源的。我认为频繁的代码提交是其实际的证据。



GhostDoc可以帮助发表XML评论。

For now I selected two tools to use for documenting and commenting code in my projects in Visual Studio 2015 - Sandcastle and GhostDoc.

Sandcastle is continuously developing and is quite powerful tool. It is free and open source. I think frequent code commits is an evidence of its actuality.

GhostDoc can help to make XML comments.

这篇关于使用visual studio和sandcastle在C＃中创建文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！