VS代码注释



随着开发的不断深入,随着开发人员的增加,随着开发人员的各种编码风格,如果没有注释,则不同编码人员就很难进行沟通和交流。 注释就像一本书中的前言,这本书对自己有没有帮助,看完前言就知道,这段代码对自己有没有帮助,看完注释就知道! 注释就像深夜里的明灯,明灯指引我们路的方向,注释帮助我们了解代码! 得体的注释让编程者如沐春风,如入芝兰之室! 勉强用了个排比,不为别的,就为体现注释的重要性。

第一中注释:类头注释

效果图:


这里写图片描述


【每次新建类的时候就会自动编写注释,包括作者、日期版本、类的功能】 实现过程:

  • 打开VS的安装文件夹,在搜索框中输入 class.cs,如下图所示

这里写图片描述


  • 用记事本依次打开每个class.cs,添加如下内容,保存退出

这里写图片描述


/********************************************************************************
** auth: Spener
** date: $time$
** desc: 尚未编写描述
** Ver.:  V1.0.0
*********************************************************************************/
  
  
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 每个class.cs都更改、保存退出以后,在打开VS新建C#类的时候就会自动生成类头注释了

第二种注释:类注释

效果图:这里写图片描述


这里写图片描述


【调用函数的时候,如图会有相应的函数提示。】


实现过程: 非常简单 在方法前面输入 : /// 三个斜杠就OK了。


第三种注释:代码段注释

效果图:


这里写图片描述


实现过程:


#region 增加新闻
//增加新闻函数
#endregion
  
  
  • 1
  • 2
  • 3

【然后就会把这段代码注释,右击–大纲显示–折叠定义,就会显示上面的中文提示,带代码量非常多的时候非常有用。】

第四种注释:一般注释

这个注释就是说如果某句话不懂,就加个注释,也是我们用的最多的一种注释



随着开发的不断深入,随着开发人员的增加,随着开发人员的各种编码风格,如果没有注释,则不同编码人员就很难进行沟通和交流。 注释就像一本书中的前言,这本书对自己有没有帮助,看完前言就知道,这段代码对自己有没有帮助,看完注释就知道! 注释就像深夜里的明灯,明灯指引我们路的方向,注释帮助我们了解代码! 得体的注释让编程者如沐春风,如入芝兰之室! 勉强用了个排比,不为别的,就为体现注释的重要性。

猜你喜欢

转载自blog.csdn.net/qq_40666136/article/details/81050316