通过设置项目输出XML文档,来强制要求写注释
来源:互联网 发布:ubuntu 10.04 源 编辑:程序博客网 时间:2024/04/20 02:49
很多程序员不习惯写注释。甚至是一些比较底层的函数都不写注释。过一段时间后调用时候,就不得不去查看实现代码,才能知道某个边界值的判断是否在函数实现中判断了。
如果手工检查是否写注释的话,很多时候因为工作一忙,就走与形式了。
前几天我的同事说在VS2005中找到的一个超简单的方式来强制写注释,如果公共函数没有写注释,或者注视书写错误,编译程序的时候就会报警告。
这个设置就是我们很多人都知道的定义输出的XML 文档,参见下图:
比如我们下面的代码:
public class Class1
{
public void aa()
{
}
///
///
///
///
protected void bb(int dd)
{
}
private void cc()
{
}
internal void dd()
{
}
}
就会报四个警告:
1、类没有写注释
2、公共函数 public void aa() 没有写注释
3、void bb(int dd) 这个函数注释中出现了不存在的参数 ff
4、void bb(int dd) 这个函数没有写 参数 dd 的注释。
通过上面一个简单的设置,就可以强制团队的成员写注释。
- 通过设置项目输出XML文档,来强制要求写注释
- 通过设置项目输出XML文档,来强制要求写注释
- 通过设置项目输出XML文档,来强制要求写注释
- 通过设置项目输出XML文档,来强制要求写注释
- 通过设置项目输出XML文档,来强制要求写注释
- 通过设置项目输出XML文档,来强制要求写注释
- 黑马程序员:给class文件写说明书,java的说明说通过文档注释来完成
- svn强制要求提交注释
- 强制写注释
- svn提交强制写注释
- 阶段项目文档要求
- C# XML文档注释
- XML文档注释
- myeclise设置文档注释
- 通过设置SolrInputDocument 的boost来改变文档评分
- 通过设置SolrInputDocument 的boost来改变文档评分
- svn文件提交时强制写注释
- 强制svn checkin时必须写注释
- 带参数的主函数
- 女装网 www.nzw.com.cn
- 转载:Python 与 C++ 程序的简单实例对比
- 转载:怎么从文本文件某一行开始读取文本内容
- 转载:读取一个文本文件并把文件中的文本保存在一个CString对象中,如何能做到
- 通过设置项目输出XML文档,来强制要求写注释
- 想成为嵌入式程序员应知道的0x10个基本问题
- 加班后遗症
- 初涉VFP,我的体会
- 新株洲站2009年前建成
- nhibernate源码分析之一:对象映射
- vb选择文件路径
- Cisco VPN连接配置实例
- 博文视点官方博客已经开通!