C#中类的summary注释能否在实例化时显示?
可以实现这个需求
你写的/// <summary>注释写法本身就是正确的,只要满足几个小条件,鼠标悬停时就能显示注释内容:
- 确保你的IDE支持XML注释提示:常用的Visual Studio、JetBrains Rider,或是装了C#扩展的VS Code都能支持这个功能。
- 类的访问权限:如果你的
MyClass和使用它的Program在同一个项目/程序集里,默认的internal访问修饰符没问题;如果是跨项目引用,需要把MyClass改成public,否则外部项目无法读取到注释。
修正你示例里的小语法错误(少了分号),完整代码如下:
/// <summary> /// This is my class /// </summary> class MyClass {} class Program { // 鼠标悬停在m或者MyClass上都会显示上面的summary注释 MyClass m = new MyClass(); }
当你把鼠标悬停在m变量或者MyClass类型上时,IDE就会弹出你写的summary注释内容。
内容的提问来源于stack exchange,提问作者Ando Razafy
相关产品推荐
相关产品推荐

