Sandcastle通过反映源程序集并可选地集成XML文档注释,生成准确的MSDN样式,全面的文档。
我的 SHFB 遇到问题。它给了我一个关于 Masstransit.Abstractions 未解析的程序集引用的错误。我查了这个错误并解释如下: 未解决的装配参考...
作为我们构建过程的一部分,我想编写一个批处理文件来在我们的一个 dll 中运行 Sandcastle,我知道如何通过 gui 来做到这一点,我想知道是否有办法通过李司令...
我前段时间开始使用 Sandcastle 为我们的一个项目生成一个文档网站。它运行得很好,但我们总是只编写类、方法、属性的文档......
我用谷歌搜索了很多试图找到解决方案,但似乎我错过了一些东西。 大多数文章告诉我应该修改构建文件(TfsBuild.proj)。但我在任何地方都找不到该文件。
我在此配置中使用 Sandcastle (SHFB) 插件:仅内容 构建 > 演示:默认 2022 帮助文件格式 : 网站 当我查看构建后的渲染时,续表...
如何使用从另一个方法继承特定异常。是否可以做这样的事情: /// /// 概括 /// /// 如何使用<inheritdoc/>从另一个方法继承特定异常。是否可以做这样的事情: /// <summary> /// Summary /// </summary> /// <inheritdoc cref="Method2(int)" select="exception[@cref='CustomException']" /> public int Method1() { return Method2(1); } /// <summary> /// Summary... /// </summary> /// <exception cref="ArgumentException"> /// ArgumentException... /// </exception> /// <exception cref="CustomException"> /// CustomException... /// </exception> public int Method2(int count) { // do something } 当我构建文档并打开它时,方法1也不例外。目前,我的解决方法是将 id="CustomException" 添加到 Method2 并使用 <inheritdoc cref="Method2(int)" select="exception[@id='CustomException']" /> 根据文档,在没有Sandcastle的情况下使用inheritdoc的语法将是: <inheritdoc cref="Method2(int)" path="/exception[@cref='CustomException']"/> Sandcastle 文档 表明 select 属性已于 2019 年 11 月被弃用(我知道这个问题是在那之前出现的,但这就是当前的情况)。应使用等效的 path 属性来代替: <inheritdoc cref="Method2(int)" path="exception[@cref='CustomException']"/> 使用与不使用 Sandcastle 的主要区别在于 path 属性的 xpath 值以正斜杠开头。 我自己没有使用Sandcastle的经验,但我自己搜索问题时遇到了这个问题:似乎不完全支持cref属性作为inheritdoc path属性的xpath表达式中的选择器。使用 path="/exception" 为我继承了所有异常文档,但是当使用 path="/exception[@cref='CustomException']" 时,不会继承任何异常文档,而当使用 path="/exception[not(@cref='ArgumentException')]" 否定它时,所有异常文档都会被继承。我无法在任何地方找到有关此行为的任何信息;可能是因为 cref 也是 inheritdoc 的属性...
Html 页面未显示在使用 Sandcastle 帮助文件生成器构建的 .chm 中
使用早期版本的 SHFB (1.9.3.0),我可以添加“WhatsNew”html 页面内容。单个 html 文件显示在内容下 看图片 下面是 .shbproj 中用于添加 html 页面的标签 <
我正在尝试创建一个(不需要)不包含任何反射代码段的帮助系统。使用最新的Sandcastle帮助文件生成器,是否可能仅包含MAML XML文件,并且是...
我最近才开始使用Sandcastle Builder,我想知道是否有一种方法可以将生成的index.HTML发布到Web主机,以便可以从任何浏览器中看到它。谢谢
我想产生许多单独的输出CHM文件(对于单独的库,因此我为每个库都有单独的shfbproj),但是它们具有许多共同的概念性主题。我想成为...
是否有一种标准方法,用于生成API文档的工具处理部分类的XML样式注释?基本上,应该如何评论部分类/方法以便......
使用MS Word和C#xmldoc支持的帮助生成工具[关闭]
我正在寻找一个满足这些要求的帮助/文档生成工具:它应该支持c#编译器生成的xmldoc注释,或者(甚至更好)直接支持sandcastle ...
我正在寻找一个从我的VS2010 XML文档创建HTML /帮助文件的好工具。我找到了一些商业工具,比如.Net文档工具VSDocman我相信还有更多,我......
我正在使用Sandcastle帮助文件生成器构建VS 2010 C#项目的文档。我添加了编译器生成的.xml文档和项目的Visual Studio解决方案.sln文件...
当我在我的C ++项目中使用doxygen时,我只是写道:/ ** *我可以引用SomeClass甚至SomeClass :: someMethod()而不需要特殊的标记。 * /然后doxygen从“SomeClass”和“......生成链接
考虑到我有一个复杂的类结构,其中许多元素继承自其他元素。我可能在接口中定义了一个方法GetStuff(string stuffName,int count),该方法由...继承。
好奇的问题。我正在使用Microsoft的Sandcastle从我的C#代码中的XML注释生成文档。我的几个类正在实现已经评论过的接口......
我正在编写一个未完全写入的winForms项目,这意味着还有另一个程序员正在编写代码。所以我已经写了一些重要的评论......