提供 XML 代码注释

代码注释是指放置在源代码文件中的注释,集成开发环境 (IDE) 的用户可以通过 IntelliSense 功能访问这些注释。

[Visual Basic]

在 Visual Basic 中,通过 '''(三个单引号)分隔符提供 XML 代码注释。 有关更多信息,请参见 如何:在 Visual Basic 中创建 XML 文档

[C#、J#]

您可以使用 XML 文档功能来注释代码。 当用 XML 文档注释批注解决方案源文件中定义的类型和成员时,那些注释将通过 IntelliSense 功能显示,例如:

提示

在注释分部方法时,IntelliSense 功能中只出现置于实现中而不是置于定义中的注释。

有关更多信息,请参见 XML 文档注释(C# 编程指南)

[C++]

默认情况下,源代码中使用 // 或 /* 分隔符的所有注释都显示在“成员”列表中其相关成员的旁边。 有关更多信息,请参见C++ CommentsXML Documentation (Visual C++)

当您滚动列表时,Intellisense 将在突出显示的成员旁边的弹出窗口中显示最多 12 行的注释。 当某个函数存在一个以上的注释时,Intellisense 将根据注释在代码中出现的位置确定“成员”列表中所显示的注释:

  1. IntelliSense 首先显示声明中的行尾注释。 例如:

    void MyFunction();   //EOL declaration comments
    
  2. 如果 IntelliSense 未找到前一类注释,则会显示紧靠在声明上方(无空行)的注释。 例如:

    //Before declaration comments
       void MyFunction();
    
  3. 如果未在代码中找到前两类注释,则 IntelliSense 将显示定义中的行尾注释。 例如:

    int CMyAppDoc::MyVariable=2; // EOL definition comments
    
  4. 最后,如果前面几类注释均未在代码中出现,则 IntelliSense 将显示紧靠在定义上方(无空行)的注释。 例如:

    //Before definition comments
    CMyAppDoc::MyFunction() 
    {
       return; 
    }
    

请参见

参考

列出成员

其他资源

使用 IntelliSense