标签: sandcastle

如何将sandcastle帮助文件构建器项目(.shfbproj)添加到visual studio 2008解决方案？

当我使用Sandcastle Helpfile Builder创建chm时,如何在xmldoc块中将列表渲染为有序列表？

以下不起作用:

/// <list type="numbered">
///     <item>Built in support for foobar</item>
///     <item>Client gooblygook and associated javascript support</item>
///     <item>Client side ability to read values from control</item>
///     <item>AJAX support via ASP.NET callbacks</item>
///     <item>Smaller HTML and Javascript footprint when compared to the crappy thirdparty control we paid too much for.</item>
/// </list>

在我试图解决的特定情况下,列表位于<summary />元素内.

我的库使用代码契约.

有没有办法将这些合同纳入沙堡生成的文档中？

我建沙堡的文档按照这样的回答:用沙堡构建过程中自动生成HTML文件,我需要知道哪些项目在我的解决方案建立最后.我确定我错过了一些非常简单的事情.有没有简单的方法来了解我的项目正在建立什么样的订单？

我正在尝试使用<example>标记内的<code>标记在xml文档中显示示例代码.但是,当我构建Sandcastle项目时,我发现它显示为C#.<code>标记中没有语言属性.我在Sandcastle的项目属性中找不到设置.我错过了什么吗？

顺便说一下,我使用的是HtmlHelp1格式.

我有一个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得到了处理.只是让我感到困惑的是,在日志中没有关于此的条目.

在我的实现中，我有这个：

/// <inheritdoc cref="IInterface{T} this[,]"/>
public T this[long row, long column]
{
    ...
}

XMLdoc 已经存在于IInterface. 我怎样才能从那里拿起它（就像我做其他事情一样）？

我收到编译器警告：

“XXX.YYY.this[long, long]”上的警告 108 XML 注释具有语法错误的 cref 属性“IInterface this[,]”

我试图消除this从cref但这也不能工作。我需要什么语法？

我正在使用SandCastle为C#中的项目生成html文档,该项目具有多个名称空间.HTML输出只显示一个名称空间.但是,如果我去帮助/ search.html并搜索其他命名空间中的类,我可以找到并找到它们,这意味着它已经为它们生成了html.有没有办法在HTML输出中看到所有名称空间,因为它在.chm文件中？

我正在尝试使用<codeEntityReference>MAML元素创建指向自定义扩展方法的链接,一旦我构建了文档,我就会得到整个<codeEntityReference>标记内容而不是整个方法的链接.

该方法的一个示例是:

namespace SampleProject 
{
    public static class ExtensionMethods
    {
         public static bool SomeExtension<T>(this T some) => true;
    }
}

而<codeEntityReference>将如下<codeEntityReference>M:SampleProject.ExtensionMethods.SomeExtension{T}(TObject)</codeEntityReference>

上面的链接将产生类似M的输出:SampleProject.ExtensionMethods.SomeExtension {T}(T).

实际上,我在文档构建过程中遇到以下错误:

警告:BuildAssembler:警告:ResolveReferenceLinksComponent:[52e40f26-3dfe-47e0-adf1-09233e98f42e]未知的引用链接目标'M:SampleProject.ExtensionMethods.SomeExtension {T}(T)'

我错过了什么吗？那有什么不对？我试图提供方法参考:

M:SampleProject.ExtensionMethods.SomeExtension`1

......但它没有解决问题.

我将使用Sandcastle生成API文档 - 我找不到任何有关如何在该网站上执行此操作的指南.有没有人有他们推荐的快速入门指南？

我有一个相当大的解决方案,其中包含两个基于Sandcastle + Sandcastle帮助文件生成器(SHFB)的文档项目.这些项目都可以从命令行(msbuild project.shfb)正确构建,也可以使用SHFB Visual Studio 2010集成的beta版本.

当我在TeamCity中运行构建时,我在文档构建中遇到了一个神秘的构建失败.SHFB日志说明了这一点:

      [Sandcastle Help File Builder, version 1.9.3.0]
      Cached Resolve Reference  Links 2 Component.  Copyright © 2006-2011, Eric Woodruff, All Rights Reserved
      http://SHFB.CodePlex.com
  Info: CachedResolveReferenceLinksComponent: Loaded 61 cached MSDN URL entries
  Info: SaveComponent: Instantiating component.
  Info: BuildAssembler: Building topic N:MyProject
  Info: BuildAssembler: Building topic T:MyProject.ActionNotImplementedException
  Info: BuildAssembler: Building topic AllMembers.T:MyProject.ActionNotImplementedException
  Info: BuildAssembler: Building topic Methods.T:MyProject.ActionNotImplementedException
  Info: BuildAssembler: Building topic Properties.T:MyProject.ActionNotImplementedException
  Info: BuildAssembler: Building topic Overload:MyProject.ActionNotImplementedException.#ctor
  Info: BuildAssembler: Building topic M:MyProject.ActionNotImplementedException.#ctor
  Info: BuildAssembler: …

如何从Sandcastle生成的文档中隐藏从Object类继承的方法(如Equals,Finalize,GetHashCode,GetType等...).我有一个名为LicenseManager的类,它有一个方法,而Object继承的方法会阻塞显示.

我正在使用最新版本的Sandcastle + Sandcastle帮助文件生成器.

http://cl.ly/3Y2p1C0m1a3f160z0y2v

首先,我对这个问题进行了广泛的搜索,它应该可行.

我想用Sandcastle在Welcome.aml上添加一张图片.在Welcome.aml内:

<section>
<title>Short process description</title>
  <content>
    <para>
      A short description
    </para>
    <para>
      <medialinkInLine>
        <image xlink:href="ShortProcess"/>
      </medialinkInLine>
    </para>
  </content>
</section>

我已将图像添加到我的媒体文件夹并使用xlink:href中的图像ID.但没有出现.

日志文件在这里提到:

复制图像并创建媒体地图文件... C:\ blaablaaa\blaaaa\Doc\Doc\Media\ShortProcess.jpg - > C:\ blaablaaa\blaaaa\Doc\Doc\Help\Working\Media\ShortProcess.jpg Generating概念主题文件

有人有个主意吗？