我有一个带有XML文档注释的Visual Studio C#项目。我收到了包含.xml
,<summary>
,<param>
和<returns>
成员的<example>
个文件。
我在<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帮助文件生成器GUI版本2018.5.29.0。
我试图在项目属性中显示任何内容,这些内容在文档中给了我很多不需要的额外元素,但没有一个让我<return>
或<params>
。
答案 0 :(得分:0)
你能勾选
吗?为不存在的XML注释元素添加“缺少文档”警告
适用于<param>
和<return>
代码?
它有什么改变吗?您至少应该获得文档中的Parameters
和Return Value
部分。
如果这也不起作用,请确保已勾选
XML文档文件
在Visual Studio中的项目属性构建页面上描述here。
答案 1 :(得分:0)
出于某种原因,如果我在Visual Studio中制作一个Sandcastle项目,问题就解决了,我也得到一个非常好的语法部分。 我仍然不明白为什么它不能在Sandcastle GUI中工作,但这对我有用。 谢谢你的帮助
编辑: 实际上我刚刚找到了真正的问题。当我包含项目时,我认为我必须将目标框架从4.5更改为4.6.1,就像在我的C#项目中一样。奇怪地改回来并不能解决问题,但是在不改变该属性的情况下创建一个新项目。以防有人有同样的问题。