Tag: sandcastle

并非所有命名空间都包含在Sandcastle构建文档中

我有一个C＃项目，在一个解决方案中有两个名称空间。 我已经记录了两个命名空间中的所有类/函数/成员/等。 由于该项目是一个小型研究项目，因此命名空间是DocTestLibrary和DocTestLibrary.Events 。 但是，当我尝试通过Sandcastle从中创建文档时，它只会为DocTestLibrary命名空间创建文档。 我是否需要在Sandcastle中进行任何设置才能使其工作？ 我对此表示怀疑，因为我已经仔细研究了大部分内容。 奇怪的是，Doxygen能够很好地生成文档。 为了提供更多信息，我检查了Sandcastle为构建生成的日志。 看来这个条目导致其余的不显示。 Warn: ResolveReferenceLinksComponent2: Unknown reference link target ‘T:DocTestLibrary.Events.DemoEvent’. 我还发现了别的东西。 DocTestLibrary命名空间由两个类组成： 识别TestClass StaticHelper 顾名思义，StaticHelper是一个只有静态方法的辅助类。 然而，Sandcastle也否认要处理这个文件。 只有TestClass得到了处理。 只是让我感到震惊的是，日志中没有关于此的条目。

是否可以在Sandcastle文档中包含自定义属性？

是否可以在Sandcastle文档中包含自定义属性？ 例如，考虑这个c＃方法： public void ExampleMethod ( [Required] string input1, [DefaultValue(“example”)] string input2 ) 有没有办法让Sandcastle文档输出input1具有必需的属性？

如何禁用特定文件的特定编译器警告

背景 我正在开发一个小型编码项目，该项目将被出售给其他公司。 我需要为它创建一些文档，所以我决定使用Sandcastle。 经过很长时间的下载和安装后，我终于开始工作，并注意到任何没有评论的公共方法或类都有红色文字说明评论缺失。 然后我安装了Ghostdoc来帮助加快我的评论速度。 这打开了编译器警告缺少xml注释，这很好，因为我现在有一个我需要评论的所有内容的列表。 问题 我的一个代码文件是一个自动生成的文件，其中包含大约3000个编译器警告。 我需要能够跳过该文件来创建任何“Missing Xml Comment”编译器警告。 我从这篇文章中了解到这些： 我知道我可以关闭项目的编译器警告，但项目中还有其他文件应该有编译器警告。 我知道我可以使用#pragma warning disable 1591删除编译器警告，但该文件是自动生成的，我真的不想每次都要手动重新添加它。 我知道我可以添加一个空注释，但是再一次，我真的不想在每次重新生成文件时重新添加它。 我可以把文件放到它自己的项目中，因为它是它的命名空间中唯一的类，然后删除XML注释要求，但我不希望客户必须处理另一个dll。 这些类是部分类，所以我正在考虑尝试找到一种方法在部分类中添加#pragma warning disable，但即使可能，仍然会有枚举警告。 如何告诉VS忽略特定类型警告的单个文件？

构建Visual Studio项目时构建Sandcastle文档

我正在使用Sandcastle帮助文件生成器将我的C＃XML-DOC文件输出为网站格式。 如何从命令行完成相同的操作，以便在构建实际项目时可以在Visual Studio中将其添加为构建事件？ 最终目标是在构建Visual Studio项目时构建网站帮助文件内容。

从VS 2010 C＃XML文档生成HTML /帮助文件

我正在寻找一个从我的VS2010 XML文档创建HTML /帮助文件的好工具。 我找到了一些商业工具，比如 .Net文档工具 VSDocman 我相信还有更多，我只列出这两个例子。 还有简单的XSLT样式表来将XML转换为HTML文档。 您在使用什么，例如是否有免费工具进行转换，可能是插件。 只是为了澄清，基本上我找到了两种工具： 以不同的目标格式转换XML文档文件的那些，这就是我正在寻找的。 帮助我在源代码中生成XML文档的工具。 这不是（！）我在寻找什么。 谢谢你的帮助。 Sandcastle / SHFB组合效果很好。 感谢所有帮助过的人。 一些评论： NDoc似乎已经过时，最近的更新是从2005年开始的。这就是我跳过这个的原因。 一个类似的线程，也非常详细，可以在这里找到： 如何将C＃Xml Doc-Comments变成有用的东西？ 谢谢你的提示！ Sandcastle有一些来源，我找到的最新版本位于： http ： //sandcastle.codeplex.com/ 为了生成MsHelp2我必须安装包含hscomp.exe VS 2008 SDK。 有一个版本1.0和1.1，据我所知，版本1.0包含编译器。 有关详细信息，请参阅Helixsoft和Social MSDN 。 在我的情况下，生成的WebHelp无法与Chrome正常工作。 它总是重新加载index.html页面。 此处的主题显示如何将命名空间信息添加到sandcastle文档中。 截至2012年11月更新：对于我使用Doxygen的小型项目 – 我发现它更容易配置。

在使用Sandcastle构建期间自动生成html文档

通过Visual Studio中的构建步骤，我需要采取哪些步骤来自动构建HTML文档？ 我已经准备好所有注释并生成了comments.xml文件，并安装了Sandcastle。 我只需要知道要在后期构建步骤中添加什么以生成文档。

DocProject与Sandcastle帮助文件生成器GUI

我有几个C＃项目以及一些我试图一起记录的内部库组件。 Sandcastle似乎是从C＃生成文档的地方。 我想知道DocProject或Sandcastle帮助文件生成器GUI中的哪一个更好，并支持我需要的function。 我想只编译每个项目自己的文档部分，然后将它们全部集成到一起。 （即一个文档项目中的库组件和它自己的文档项目中的每个项目，然后使用Help 2查看器在单个根目录中的所有上述内容）