如何正确转义 Xml 文档中 <code> 示例的内容?
How to properly escape the content of a <code> example in Xml documentation?
在 .Net Xml 文档的 <code>
标签中转义 VB 和 C-Sharp 非法字符如 <>&
的方法是什么?
在下面的这个例子中,Intellisense 高亮了 >
字符,因为我需要转义它,它说生成文档时不会包含代码,因为原因。
''' ------------------------------------------------------------------------
''' <summary>
''' </summary>
''' ------------------------------------------------------------------------
''' <example> This is a code example.
''' <code>
'''
''' Dim currentPosition As Long = CLng(player.Position.TotalMilliseconds)
'''
''' If Not ((currentPosition + 5000) >= player.Length) Then
''' player.Seek(currentPosition + 5000)
''' End If
'''
''' </code>
''' </example>
''' ------------------------------------------------------------------------
Sub Something
End Sub
那么,我应该如何对代码内容进行转义呢?
我有疑问,因为 <code>
标签的内容被视为文字文本,那么如果我添加一个 CDATA
标签来避免 IntelliSense 错误,当我生成Chm/Html 文件与该文档?,我的意思是 CDATA
标记符号将在代码示例中表示为升文本,从而以这种方式导致剩余,或者什么?
有人可以提供一个正确做事的例子吗?
您需要使用与在普通 XML(或 HTML)文档中相同的转义类型(see here 了解更多信息)。
将 &
替换为 &
,将 <
替换为 <
,将 >
替换为 >
。您可能需要注意的另一个是引号字符。 "
被替换为 "
。
在 .Net Xml 文档的 <code>
标签中转义 VB 和 C-Sharp 非法字符如 <>&
的方法是什么?
在下面的这个例子中,Intellisense 高亮了 >
字符,因为我需要转义它,它说生成文档时不会包含代码,因为原因。
''' ------------------------------------------------------------------------
''' <summary>
''' </summary>
''' ------------------------------------------------------------------------
''' <example> This is a code example.
''' <code>
'''
''' Dim currentPosition As Long = CLng(player.Position.TotalMilliseconds)
'''
''' If Not ((currentPosition + 5000) >= player.Length) Then
''' player.Seek(currentPosition + 5000)
''' End If
'''
''' </code>
''' </example>
''' ------------------------------------------------------------------------
Sub Something
End Sub
那么,我应该如何对代码内容进行转义呢?
我有疑问,因为 <code>
标签的内容被视为文字文本,那么如果我添加一个 CDATA
标签来避免 IntelliSense 错误,当我生成Chm/Html 文件与该文档?,我的意思是 CDATA
标记符号将在代码示例中表示为升文本,从而以这种方式导致剩余,或者什么?
有人可以提供一个正确做事的例子吗?
您需要使用与在普通 XML(或 HTML)文档中相同的转义类型(see here 了解更多信息)。
将 &
替换为 &
,将 <
替换为 <
,将 >
替换为 >
。您可能需要注意的另一个是引号字符。 "
被替换为 "
。