5

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

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

有什么明显的我忽略了吗？SandCastle 不阅读财产摘要吗？还是摘要需要不同的关键字？

4

3 回答 3

7

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

之后，Sandcastle 会在“Description”栏输出“summary”评论。

于 2014-10-10T12:40:57.723 回答
3

从 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>

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

于 2012-06-07T20:11:41.517 回答
0

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

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

成员“M: ...

然后，像我一样，您可能包含了一些 XML 不太喜欢的字符。我在评论中使用了“&”，但是如果你也使用“<”或“>”，XML 会向你大喊大叫。修复您的评论，您应该一切顺利！

于 2015-06-12T16:27:17.543 回答