Visual Studio XML注释(摘要)和特殊字符

ste*_*wpf 12 visual-studio-2010 visual-studio

我在C#/ Wpf项目中有一个方法,我想用这样的XML注释来评论/记录它

    /// <summary>
    /// Initialises Drag & Drop
    /// </summary>
    void initDragDrop()
    {

    }
Run Code Online (Sandbox Code Playgroud)

当我现在在我的项目中的某个地方使用此方法并将鼠标悬停在它上面时,我收到消息"XML注释包含无效的XML:在这个地方,不允许空格"(我将冒号后的文本手动翻译成英文,所以它可能不是你的视觉工作室中的字面意思).我发现问题是"&"符号,如果我删除它,它工作正常.但是我想保留它,那么如何在XML摘要中将其转义呢?我试过"\&"但这不起作用.

谢谢你的提示!

Joe*_*orn 18

请记住,&字符在xml(实体的开头)中具有特殊含义.你需要写这样的评论(烦人,我知道):

/// <summary>
/// Initialises Drag &amp; Drop
/// </summary>
void initDragDrop()
{

}
Run Code Online (Sandbox Code Playgroud)

我可能在下一点上错了,但我认为你甚至不能使用CDATA部分来避开实体,因为它会破坏评论.您必须输入整个&amp;实体.

  • 不要忘记您需要对 &lt;、&gt; 和 " (&lt; &gt; ") 执行相同的操作。如果您想生成 HTML、CHM 或其他格式的类似 MSDN 的文档,您可以使用免费的 Sandcastle 或我们的 VSdocman .VSdocman 还包含注释编辑器,它会自动转义所有必要的字符。 (2认同)