c#中如何规范化注释

  

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

  

1。文件级注释

  

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

            C #中如何规范化注释”>,
  
  
  
  
  
  <p>上面示例给出了一个较为典型的文件级注释,读者可以根据自身的情况,指定统一的注释规范。</p>
  <p> 2。函数级注释</p>
  <p>函数级注释用于说明某个函数具体完成的功能,输入参数类型、输出结果等信息,便于函数的调用。一个典型的函数级注释如下所示。</p>
  
  
  
  <img src=c#中如何规范化注释