结对作业之代码规范

  • 缩进:缩进使用4个空格的方式;

  • 括号:在复杂的条件表达式中,用括号清楚的表示逻辑优先级;

  • 断行与空白的{}行:程序结构风格使用断行和空白的{}行;

    (在程序调试时期需要单步执行需要断行,在程序复杂代码量大时空白{}使结构清晰明了)

  • 分行:在定义不同变量或对多个变量进行赋值时不要放在一行上,即多条语句不要放在一行上;

  • 命名规则:

  1. 采取类似“匈牙利命名法”,变量名尽量使得程序员一眼便能看出其含义或类型;
  2. 采取简便缩写格式,对于可以简写表示的变量不需要过多描述;
  3. 避免不必要的修饰词,如果删减修饰词程序不会变的难懂,那么便可删减;
  4. 使用下划线分隔变量名中的作用域标注和变量的语义;比如Word_Count;
    • 所有的类型/类/函数名都用Pascal形式:所 有单词的第一个字母都大写;

    • 所有变量使用Camel形式,第一个单词全部小写,随后单词随Pascal形式;
  5. 程序中一些比较复杂容易混淆的代码都需要做出相应的注释,目的是:解释程序做什么,为什么这么做;复杂的注释应该放在函数头,相对简单不必要的注释(例如解释函数参数类型的注释)可以省去;

猜你喜欢

转载自www.cnblogs.com/heihuifei/p/9656750.html