很多程序员不习惯写注释。甚至是一些比较底层的函数都不写注释。过一段时间后调用时候,就不得不去查看实现代码,才能知道某个边界值的判断是否在函数实现中判断了。

如果手工检查是否写注释的话,很多时候因为工作一忙,就走与形式了。

前几天我的同事说在VS2005中找到的一个超简单的方式来强制写注释,如果公共函数没有写注释,或者注视书写错误,编译程序的时候就会报警告。

这个设置就是我们很多人都知道的定义输出的XML 文档,参见下图:

设置项目的输出XML文档

比如我们下面的代码:

public class Class1


public void aa()



/// <summary>
/// 
/// </summary>
/// <param name="ff"></param>
protected void bb(int dd)



private void cc()



internal void dd()

}

 

就会报四个警告:

设置输出XML文档后,没有写注释,出现的警告

1、类没有写注释

2、公共函数 public void aa() 没有写注释

3、void bb(int dd) 这个函数注释中出现了不存在的参数 ff

4、void bb(int dd) 这个函数没有写 参数 dd 的注释。

 

通过上面一个简单的设置,就可以强制团队的成员写注释。

Posted on 2007-05-18 16:43  Clark Zheng  阅读(666)  评论(5编辑  收藏  举报