沙堡不记录财产摘要

本文关键字：财产 记录 | 更新日期: 2023-09-27 18:36:41

我今天第一次将SandCastle与HelpBuilder GUI一起使用，以帮助创建一些公开的函数和属性的API。我已经在许多属性中包含了/// <summary> ... </summary，我认为它们将从额外的文档或使用示例中受益。

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

我是否忽略了什么明显的东西？沙堡不看房产摘要吗？还是摘要需要不同的关键字？

沙堡不记录财产摘要

你必须告诉Visual Studio在编译时生成XML文档文件： 只需设置相应的项目属性，如下所述：http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0（v=vs.100）.aspx

之后，沙堡将在"描述"列中输出"摘要"注释。

来自沙堡常见问题帮助页面：

文档中缺少代码注释

默认情况下，项目的所有 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>

有关详细信息，请参阅此博客文章。

看起来另一个答案已经被接受为有效，但我要添加我的解决方案，因为我有同样的问题，但有另一个原因。

如果打开用作文档源的 XML 文件，请控制您为其编写注释但未显示在最终沙堡文档中的方法/属性。如果您看到以下消息：

忽略成员"M： ...

然后，像我一样，您可能包含了一些 XML 不太满意的字符。我在注释中使用了"&"，但是如果您也使用"<"或">"，XML会对您大喊大叫。修复您的评论，您应该很高兴！

相关文章：