DocProject vs Sandcastle帮助文件生成器GUI

我有几个C＃项目以及一些内部库组件，我试图一起记录。 Sandcastle似乎是从C＃生成文档的地方。我想知道DocProject或Sandcastle帮助文件生成器GUI中的哪一个更好，并且支持我需要的功能。DocProject vs Sandcastle帮助文件生成器GUI

我想只编译每个项目拥有文档的一部分，然后把它全部集成在一起到底。（即一个文档项目中的库组件和每个项目都在它自己的文档项目中，然后使用Help 2查看器在单个根中执行上述所有操作）

来源

2008-11-26 Nathan

我可以为Sandcastle帮助文件生成器进行担保。它工作得很好，您可以在Sandcastle Help File Builder项目中记录任意数量的程序集。从理论上讲，您可以拥有一个Builder项目并为每个C＃项目生成一个文档，然后拥有一个记录所有内容的主生成器项目。

来源

2008-12-03 01:42:11

这里是沙堡基于.NET文档一些有用的链接：

Tutorial on Sandcastle

Sandcastle Help File Builder（SHFB）
Tutorial on SHFB

Web Project Documentation
Tutorial on how to document Web Projects（更多手动和我相信过时给出先前的链接）

MSDN reference for XML Documentation

来源

2008-12-29 16:35:27

Sandcastle非常慢，并且需要安装和手动引用诸如Microsoft.Scripting.dll v1.1.0.20等依赖项。如果您已经将文档以XML格式编写，并且您希望编译文档的库，那么它的效果也最好。在使用现代四核系统的中等规模的图书馆中，期望等待1小时或更长时间才能构建文档。 – 2015-03-14 18:32:27

文档项目产生更精致的文档 - 当它工作 - 这是不是所有的时间。这是一个更加风格化的产品。

沙堡帮助文件生成器是固体和能够完成任务。

来源

2009-05-19 15:01:20 Tekdream

沙堡是废话。 – 2015-03-12 06:45:12

我没有用DocProject但似乎与能力堪比沙堡的产物。

我用Sandcastle，我发现这是一个有效的工具。您还需要Sandcastle Help File Builder（SHFB）为您提供一个良好的前端，正如其他人在此提到的那样。此外，您需要Sandcastle Styles用于Sandcastle引擎的表示层补丁。尽管所有这三个组件在2010年中期都有新版本，但由于Firefox 3.6中存在渲染缺陷（2010.09.06条目中记录了此defect report），我推迟了2008版本的升级。

我已经彻底证明我的描述这个问题和各种其他的，你可能需要或希望以产生一个整洁，专业的文档集要考虑平台的经验。我的文章“Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code”刚于2010年9月在Simple-Talk.com上发布;它可能会节省你一些时间，精力和痛苦:-)。

来源

2010-09-14 23:06:03

DocProject是Sandcastle的ADDON。它不是一个独立的应用程序>> https://docproject.codeplex.com/ – 2015-03-12 06:46:57

DocProject vs Sandcastle帮助文件生成器GUI

回答

相关问题