【C#】Summary注释

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

【C#】Summary注释_第1张图片

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

此外,还有两点作用:

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

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

 【C#】Summary注释_第2张图片

 所以,用///

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

你可能感兴趣的:(C#,c#,开发语言)