zoukankan      html  css  js  c++  java
  • 团队-游戏《石头,剪刀,布》-代码设计规范

    1、组织与风格
    (1).关键词和操作符之间加适当的空格。
    (2).相对独立的程序块与块之间加空行
    (3).较长的语句、表达式等要分成多行书写。
    (4).划分出的新行要进行适应的缩进,使排版整齐,语句可读。
    (5).长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
    (6).循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分。
    (7).若函数或过程中的参数较长,则要进行适当的划分。
    (8).不允许把多个短语句写在一行中,即一行只写一条语句。
    (9).函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

    2、注解
    Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?
    // 注释一行
    /* ...... */ 注释若干行
    不完全对,除了以上两种之外,还有第三种,文档注释:
    /** ...... */ 注释若干行,并写入 javadoc 文档
    注释要简单明了。
    String userName = null; //用户名
    边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
    在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防止注释二义性。
    保持注释与其描述的代码相邻,即注释的就近原则。
    对代码的注释应放在其上方相邻位置,不可放在下面。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;
    同一结构中不同域的注释要对齐。
    变量、常量的注释应放在其上方相邻位置或右方。
    全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
    在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等);主要函数或过程清单及本文件历史修改记录等。

    在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等

    3、命名规范
    定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)较短的单词可通过去掉元音形成缩写;要不然最后自己写的代码自己都看不懂了,那可不行

    参数的命名
    参数的名字必须和变量的命名规范一致。
    数组的命名
    数组应该总是用下面的方式来命名:

    byte[] buffer;
    而不是:
    byte buffer[];

    方法的参数
    使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:
    SetCounter(int size){
    this.size = size;
    }

    4、代码可读性
    避免使用不易理解的数字,用有意义的标识来替代。
    不要使用难懂的技巧性很高的语句。
    源程序中关系较为紧密的代码应尽可能相邻。
    5、代码性能
    在写代码的时候,从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上,而是我们时刻应该提醒自己要注意代码的效率。比如:如果没有时间来实现一个高效的算法,那么我们应该在文档中记录下来,以便在以后有空的时候再来实现她。
    不是所有的人都同意在写代码的时候应该优化性能这个观点的,他们认为性能优化的问题应该在项目的后期再去考虑,也就是在程序的轮廓已经实现了以后。
    不必要的对象构造
    不要在循环中构造和释放对象

  • 相关阅读:
    软件质量属性简述
    浅谈MVC架构
    SOA整理
    程序员的自我修养阅读笔记3
    程序员的自我修养阅读笔记2
    程序员的自我修养阅读笔记1
    架构漫谈阅读笔记3
    架构漫谈阅读笔记2
    Weather APP
    php通过==和!==比较NULL和''结果均为真
  • 原文地址:https://www.cnblogs.com/yxcyxc/p/7840300.html
Copyright © 2011-2022 走看看