【C#】Summary注释

初学C#，研究公司代码的时候，看到这样注释，感觉这样写很奇怪，每次这样写会很麻烦吧。

查资料后发现，在写好的方法的上一行打出“///”，系统会自动补全，是一个很方便的注释方式

此外，还有两点作用：

1.这些注释可以生成一个xml文件，方便生成程序说明文档

2.引用该方法时，鼠标移上，会显示出注释的提示。

所以，用/// <summary>写注释的方法更好用，尤其是用于写库文件的时候，因为这种文件我们看不到源码，只有这种的注释，能够让调用者看到，同时，在写C#函数的注释的时候（特别是写给别人去调用的接口的时候），能用这种写法，就用这种写法，既显得专业，又好用。

【C#】Summary注释相关推荐

请问C#中如何自动生成summary注释
/// (summary的框架就出来了) 参考:http://bbs.csdn.net/topics/310178351 转载于:https://www.cnblogs.com/hellolong/a ...
ef生成mysql字段注释_EFcore+MySql 数据迁移的时候，怎么给表结构加注释？
前言: CodeFirst运用的场景比较少,不代表CodeFirst不好,也不能和DbFirst去作比较,本来就是两个东西. 吐槽: MySql.Data.EntityFrameworkCore 作为 ...
unity 快捷键之summary
定义好函数,在函数前面输入三个/(///)自动出现summary注释. /// <summary>/// /// </summary>void Test() {}
C#中的summary
初学C#,看公司代码的过程中一步一步学习,现将学习过程中发现的一些知识总结整理出来,无论难易,以供后续不时之需. 在C#中,<summary> 标记应当用于描述类型或类型成员. 使用 &l ...
oracle web API,在Web API程序中使用Swagger做接口文档
#### 创建Web API程序在VS2019中创建一个ASP.NET Web应用程序,选择Web API来创建RESTful的HTTP服务项目,构选MVC和Web API核心引用. #### 安装 ...
一年以来我最好的创意
从Kanas.Net 1.0开始,我对元数据的处理都是这样的: TypeBroker:收集与实体类型相关的元数据信息,包括反射信息和映射信息: PropertyBroker:收集与实体类型的属性相关的 ...
项目Alpha冲刺——代码规范、本次冲刺任务与计划
作业格式课程名称:软件工程1916|W(福州大学) 作业要求:项目Alpha冲刺(团队) 团队名称: 那周余嘉熊掌将得队作业目标:代码规范.本次冲刺任务与计划团队信息: 队员学号队员姓名博客 ...
基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化，Swagger登场
基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场转载于:https://github.com/Meowv/Blog.git 在程序员界,总有一批强迫 ...
C#进阶系列——WebApi 接口测试工具：WebApiTestClient
正文前言:这两天在整WebApi的服务,由于调用方是Android客户端,Android开发人员也不懂C#语法,API里面的接口也不能直接给他们看,没办法,只有整个详细一点的文档呗.由于接口个数有点 ...

【C#】Summary注释

【C#】Summary注释相关推荐

最新文章

热门文章