Sandcastle 不生成参数或 return

Question

我有一个带有 XML 文档注释的 Visual Studio C# 项目。我得到一个包含 <summary>、<param>、<returns> 和 <example> 成员的 .xml 文件。

我放在 <summary> 标签之间的文本显示在帮助文件以及 Namespace、Assembly、Example 和 See Also 部分中.只是 <param> 和 <returns> 甚至没有一个空的部分，即使它构建没有错误。

生成的相关部分.xml:

<member name="M:OPC_ClientLib.OPC_Client.getBit(System.String)">
    <summary> the summary text (is shown) </summary>
    <param name="variable">Variable name (not shown)</param>
    <returns>true or false, (not shown)</returns>
    <example>
        <code> bool bit = getBit("bitname")</code>
    </example>
</member>

实际输出

我使用 Sandcastle Help File Builder GUI 版本 2018.5.29.0.

我试图在项目属性中显示任何内容，这些内容在文档中给了我很多不需要的额外元素，但是 none 其中让我 <return> 或 <params>.

Answer 1

你能打勾吗

Include a 'missing documentation' warning for XML comment elements not present

对于 <param> 和 <return> 标签？它有什么改变吗？您至少应该在文档中获得 Parameters 和 Return Value 部分。

如果这也不起作用，请确保您已勾选

XML documentation file

在 Visual Studio 的项目属性构建页面上，如 here 所述。

Answer 2

出于某种原因，如果我在 Visual Studio 中创建了一个 Sandcastle 项目，问题就解决了，而且我还得到了一个相当不错的语法部分。我仍然不明白为什么这在 Sandcastle GUI 中不起作用，但这对我有用。感谢您的帮助

编辑：实际上我刚刚发现了真正的问题。当我包含该项目时，我认为我必须将目标框架从 4.5 更改为 4.6.1，就像在我的 C# 项目中一样。奇怪地把它改回来并不能解决问题，但是在不改变属性的情况下创建一个新项目。以防万一有人遇到同样的问题。

Sandcastle 不生成参数或 return

Sandcastle not generating params or return

c#

sandcastle

xml-documentation

xml-comments