Sandcastle没有记录财产摘要

Question

我今天第一次使用SandCastle和HelpBuilder GUI来帮助创建一些我们公开的函数和属性的API.我已经包含/// <summary> ... </summary了许多属性,我觉得他们会从额外的文档或使用示例中受益.

当我将输出文件构建到chm时,我根本没有看到摘要描述.列出了所有属性成员,但其描述为空白.我重建了这个项目,并在SandCastle中尝试了一些不同的设置,但它们仍然没有显示出来.

我有什么明显的东西可以忽略吗？SandCastle没有阅读财产摘要吗？或者摘要需要不同的关键字？

Answer 1

您必须告诉Visual Studio在编译时生成XML文档文件:只需按照此处所述设置相应的项目属性:http: //msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v = vs. 100)的.aspx

之后,Sandcastle将在"描述"列中输出"摘要"注释.

Answer 2

从 Sandcastle常见问题帮助页面：

文档中缺少代码注释

默认情况下，项目的所有 XML 文档都应位于名为 comments.xml 的单个文件中。如果您有多个 XML 文档文件，请将它们放在名为 Comments 的新文件夹中，并调整 sandcastle.config 以使用通配符，如下例所示。

<!-- Copy in comments -->
<component type="Microsoft.Ddue.Tools.CopyFromIndexComponent"
           assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
  <index name="comments" value="/doc/members/member"
         key="@name" cache="100">
    <data base="%SystemRoot%\Microsoft.NET\Framework\v2.0.50727"
          recurse="false" files="*.xml" />

    <data files="Comments\*.xml" />  <!-- This line was modified -->

  </index>
  <copy name="comments" source="*" target="/document/comments" />
<components>

有关更多信息，请参阅此博文。