2010-04-20 116 views
11

我有一个C#/ WPF项目的方法,我想评论/文档使用这样Visual Studio的XML注释(摘要)和特殊字符

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

    } 

当我现在使用的XML注释它这个方法在我的项目的某个地方,并将鼠标悬停在它上面,我收到消息 “XML注释包含无效的XML:在这个地方,不允许有空格”(我将结果手动翻译为英文,所以它可能不会在字面上你的视觉工作室)。 我发现问题是“&”的标志,如果我删除它,它工作正常。但是我想保留它,所以如何在XML摘要中将其转义?我试过“\ &”,但这不起作用。

感谢您的任何提示!

回答

16

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

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

} 

我可能是错在这一个点,但我不认为你甚至可以用一个CDATA部分,以避免实体,因为它打破了评论。您必须键入整个&amp;实体。

+1

其实,你可以使用CDATA。以下是我的一个项目的示例:http://kbcsv.codeplex.com/sourcecontrol/network/Show?projectName=kbcsv&changeSetId=42031#530479。另一种方法是将文档移动到一个单独的文件中,并将其转入源文件中。 – 2010-04-20 16:24:38

+0

谢谢,知道的很好。 – 2010-04-20 16:26:29

+0

谢谢你们的回复!肯特,使用你的链接我已经看到,你的课堂是有据可查的。我想你是从这个生成一些HTML的孩子?这个任务你使用了哪个工具?上次我查找这样的工具,他们都是早期的网络版本,或者很难用于初学者。 我会接受joels的答案,首先它是一个简短的解决方案,第二个肯特添加他的解决方案作为评论这是不可标注的,否则我也会标记它;-) – 2010-04-20 16:40:31