c# - 当在类上调用点运算符时,C# 在方法上显示文档
问题描述
有没有一种以编程方式记录类中的方法并让文档显示的方法,就像用户调用点运算符(例如,String.[method])并可以查看类中的特定方法所做的那样?见屏幕截图。我想在 C# 中为一个类创建自定义方法,然后记录它。然后,当用户使用该类并启动点运算符 (.) 时,他们将看到方法和描述该方法的文档
解决方案
是的。使用XML 文档注释。
在 Visual C# 中,您可以通过在源代码中的特殊注释字段(由三个斜杠表示)中直接在注释所引用的代码块之前包含 XML 元素来为您的代码创建文档,例如:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
另请参阅使用 XML 注释记录您的代码
该
<summary>
标记非常重要,我们建议您包含它,因为它的内容是 IntelliSense 或 API 参考文档中类型或成员信息的主要来源。
推荐阅读
- python - 我的电报机器人使用 opencv 从相机接收图像给我一个错误并且不起作用
- python - 如何在 python 中编写 if、else 语句以将数据字符串附加到目录中的特定文件?
- datatable - 将分号视为primefaces OutputText中的分隔符
- authentication - 使用 AddCookies 中间件时未生成 Cookie
- java - Heroku 上的 JVM 内存不一致
- .htaccess - 将查询字符串转换为 seo 友好的 url 但允许其他查询字符串
- swift - 无法从 Firestore 获取数据
- azure-devops - 生成 Azure DevOps 发行说明
- mysql - 如何在 mysql/mariadb 中隐藏版本和名称?
- python - Django从url加载图像-反对的ImageField没有属性_committed