C#中如何规范化注释

注释对于增加程序的易读性和可维护性非常重要,同时在编程的过程中,也有助于程序员使其思路更加清晰,降低出现逻辑错误的几率。对于注释的风格,往往采取下面的策略。

成都创新互联公司专业为企业提供衢江网站建设、衢江做网站、衢江网站设计、衢江网站制作等企业网站建设、网页设计与制作、衢江企业网站模板建站服务,10多年衢江做网站经验,不只是建网站,更提供有价值的思路和整体网络服务。

1.文件级注释

文件级注释在于说明整个代码文件的功能,常常还包含作者信息、创建日期信息等,便于代码的后期维护。一个典型的文件级注释如下所示。

  C#中如何规范化注释 

上面示例给出了一个较为典型的文件级注释,读者可以根据自身的情况,指定统一的注释规范。

2.函数级注释

函数级注释用于说明某个函数具体完成的功能、输入参数类型、输出结果等信息,便于函数的调用。一个典型的函数级注释如下所示。

  C#中如何规范化注释 

VS.NET开发环境可以自动生成这个风格的函数注释,只需要在方法前输入"//",VS.NET就自动生成注释框架,开发者只需要在相应的地方填入相应的值就可以了。

这种风格的注释还有其他优点,即当开发者使用这个方法时,VS.NET会给出提示信息。根据上面的例子,在使用SetInfomation方法时VS.NET给出的提示信息。

3.代码功能块级注释

在逻辑严密的方法实现中,常常是一个代码块完成一个特定的子问题,称这样一个代码块为功能块。对于函数的功能块添加注释可以理顺整个函数的功能,尤其体现在行数较多的函数中。如下面的示例所示。

  C#中如何规范化注释 

 

  C#中如何规范化注释  

 

如上面的示例,代码功能块级的注释往往可以注释到这个功能块的上面一行,而各个功能块之前使用空行来分隔。有了这样的功能块注释,整个函数的实现逻辑显得更为清晰,便于从整体上把握函数的实现,避免在实现一些逻辑复杂的功能时出现混乱。

4.代码行级注释

除了上面3种注释,还需要在代码行上加必要的注释以进一步增强代码的可读性,当然,并不需要在每一行上都加注释,只需要在比较复杂的某些行上加以注释即可。代码行级的注释往往加在本行的后面,如下所示。

 

  C#中如何规范化注释

网页名称:C#中如何规范化注释
网站链接:http://bzwzjz.com/article/gjicdg.html

其他资讯

Copyright © 2007-2020 广东宝晨空调科技有限公司 All Rights Reserved 粤ICP备2022107769号
友情链接: 手机网站建设套餐 四川成都网站建设 成都营销网站建设 教育网站设计方案 定制网站建设多少钱 重庆企业网站建设 外贸网站设计方案 成都网站建设流程 高端网站设计 自适应网站设计 成都品牌网站设计 营销网站建设 温江网站设计 LED网站设计方案 成都网站制作 攀枝花网站设计 公司网站建设 手机网站制作 重庆企业网站建设 成都网站建设 成都网站建设 成都网站制作