Sandcastle帮助文件生成器未显示.ascx.designer.vb文件中html/asp.net元素的xml注释文档

我正在使用Sandcastle帮助文件生成器为VB.net项目生成文档，但是asp.net/html元素的文档没有出现

这些控件的xml注释在.ascx.designer.vb文件中为相应的Web窗体或Web窗体用户控件定义。该代码的示例如下所示：

Partial Public Class WebUserControl    
    '''<summary>
    '''TblsDiv control.
    '''</summary>
    '''<remarks>
    '''Auto-generated field.
    '''To modify move field declaration from designer file to code-behind file.
    '''</remarks>
    Protected WithEvents TblsDiv As Global.System.Web.UI.HtmlControls.HtmlGenericControl 
End Class

部分公共类WebUserControl
'''
''TblsDiv控制。
'''
'''
''自动生成的字段。
''将字段声明从设计器文件修改为代码隐藏文件。
'''
受事件TblsDiv保护，如Global.System.Web.UI.HtmlControl.HtmlGenericControl
末级

在由Sandcastle help file Builder创建的帮助文件中，这些元素的文档显示为空白，就好像没有xml注释一样

---

这是Sandcastle Help File Builder的一个问题，还是有其他方法将xml注释添加到相应的html/asp.net元素？

在做了一些研究后，我发现的唯一问题是2007年SHFB开发人员的一个非常古老的答案

VB.NET编译器在幕后执行一些导致此问题的操作。在XML注释文件中，“bw”成员被记录为一个字段（F:AbstractApp.bw），表面上看起来是正确的。但是，编译器将其转换为私有字段（_bw），使用AccessedThroughProperty属性对其进行修饰，并创建一个名为“bw”的受保护属性（P:AbstractApp.bw）。因此，XML注释被忽略，因为它们现在引用的字段不存在，并且编译器生成的属性没有注释。同样有趣的是，在文档构建中包含内部或私有成员之前，属性不会显示，因为_bw是私有的，所以如果省略它们，它就看不到属性

必须这样做是一件痛苦的事情，但是您可以创建一个“仅注释”XML文件，并为编译器创建的属性向其中添加XML注释。另一个选项，如果它们没有那么重要，则关闭文档私有和内部选项，或者使用API过滤器来清除它们，这样它们就不会出现在文档中

但在我看来，这是一个至今仍然存在的问题

请注意，我不是ASP.net开发人员，我只能在此阶段使用Visual Studio Community 2015和Sandcastle Help File Builder（SHFB）版本2019.15.9.0进行测试

用于在

WebUserControl1.ascx.vb中进行测试的我的代码段

：

“”
''测试Sandcastle帮助文件生成器（SHFB）
''' 
部分公共类WebUserControl
'''
''TblsDiv控制。
'''
'''
''这仅用于测试用例。
''Sandcastle帮助文件生成器（SHFB）未显示html的xml注释文档。
'''
受事件TblsDiv保护，如Global.System.Web.UI.HtmlControl.HtmlGenericControl
末级

构建解决方案将产生一个文件

WebForms\u Basic.xml

I，作为SHFB项目资源管理器中的文档源添加

<member name="T:WebApplication2.WebUserControl">
 <summary>
 TEST Sandcastle Help File Builder (SHFB)
 </summary>
</member>
<member name="F:WebApplication2.WebUserControl._TblsDiv">
<summary>
TblsDiv control.
</summary>
<remarks>
This is for test case only.
Sandcastle Help File Builder (SHFB) not showing documentation for xml comments for html.
</remarks>
</member>

是你期望的结果。你需要根据自己的需要调整它

---

您使用的是哪个版本的Visual Studio？

<member name="P:WebApplication2.WebUserControl.TblsDiv">