繁体   English   中英

开始C#注释块的星号数

[英]Number of asterisks starting a C# comment block

在Visual Studio 2010中的C#程序中,我有一个大的,多行注释块,从

/ **

通过注释块的一部分是看起来像这样的一行。

this.afIODisplay =“ <” + lineToParse + Environment.NewLine + this.afIODisplay;

在小于符号处,颜色从注释绿色变为灰色,并且编译器发出警告说

对'xxxxxxxxxxxxxxx'的XML注释的XML格式不正确-'名称以无效字符开头。

(xxxx的替换专有代码标识符) 为什么编译器试图将注释块解释为XML?

作为实验,我尝试使用

&LT

但这并不能解决问题; 它只是用新的一句话代替了警告

名称以无效字符开头

并消除了向灰色的过渡。 然后,我将注释块的起始行替换为

/ *

问题就解决了!! 它也带有一整行星号。 为什么C#注释中的星号数量很重要? 还是仅仅是Visual Studio错误?

您的文档注释中的XML格式有误。 这会根据规范生成警告。 在C#5规范的附录A中:

具有特殊格式的注释可用于指导工具从这些注释和它们之前的源代码元素生成XML。 这样的注释是以三个斜杠( /// )开头的单行注释,或以斜杠和两个星号( /** )开头的定界注释。

文档注释中的文本必须根据XML的规则( http://www.w3.org/TR/REC-xml )格式正确。 如果XML格式不正确,则会生成警告,并且文档文件将包含注释,指出遇到错误。

c#中的多行注释以/ * / **开头,用于XML注释

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM