zoukankan      html  css  js  c++  java
  • 团队编程规范

     

    一、编码规范

    1、花括号对齐,缩进正确,请用JAVA风格或者C++风格。

    2、除循环变量之外,不允许单个字母的变量,循环变量的作用域应限定在循环体。

    3、temp、flag等通用的名字,作用域不应超过15行,含义不明显时应用注释说明。

    4、每个类应当有简要的注释来说明。

    5、每个函数、函数的参数和返回值,应当有简要的注释来说明。

    6、变量名称应当具有实际的意义,含义不清晰时应用注释说明。

    7、变量名称后边尽量避免过多的编号,例如number1,number2,number3,number4之类的,超过3个应当用数组。

    8、同一个函数中,若两段代码关系不紧密,应当多留出一个空行。

    9、修改代码时,请维护注释的正确性。

    10、编写可以阅读的代码,让代码自文档化。即代码本身不需要大量的注释支持,即使需要注释,也只编写够用的注释。另外,可以借助IDE生成一些代码和可以被工具识别的注释(例如Eclipse软件编写JAVA时,在函数前边打“/**”就会自动生成注释)。关于更多的介绍,请参看http://www.ibeifeng.com/tech.php?id=21165

    二、设计规范

             1、设计类时,应当考虑将来可能改变的地方,每个类应当只有一个改变的理由。

             2、父类中不要涉及到具体子类的语句,例如创建子类的对象。

             3、把可能变化的部分封装起来。

             4、一个函数应当只完成一个功能。

    三、测试规范

             1、每一段代码都应当经过走读和测试之后再提交,避免将bug留到更高的层次。

             2、测试代码可以考虑使用者根据TA的需求写,走读代码本人完成。

             3、自己书写时,可以考虑先写好测试代码,再写功能代码。

  • 相关阅读:
    面试题汇总
    Chromium中多线程及并发技术要点(C/C++)
    关于《Swift开发指南》背后的那些事
    HDU 3080 The plan of city rebuild(除点最小生成树)
    2.1.3策略模式(5.9)
    Shell脚本之监视指定进程的执行状态
    敏捷开发中的10大错误认识
    mysql插入中文数据报错:incorrect string value
    JapserReport导出PDF Could not load the following font错误
    冒泡排序
  • 原文地址:https://www.cnblogs.com/juicygroup/p/3346016.html
Copyright © 2011-2022 走看看