Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.57 KB

codestyle.md

File metadata and controls

45 lines (27 loc) · 1.57 KB
  • ##代码规范

    ####1.缩进

      缩进一律定为4格
    

    ####2.变量命名

      1.命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束;
      2.严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式;
      3.常量命名全部大写,单词间用下划线隔开
    

    ####3.每行最多字符数

      不超过120个字符,并且超过换行时第二行缩进四格,原则上不允许一个标识符被隔成两行
    

    ####4.函数最大行数

      不超过150行,超过需要视情况对代码块进行函数封装
    

    ####5.函数、类命名

      1.函数名使用有意义的英文进行命名,多个单词使用下划线分开
      2.类名使用UpperCamelCase风格,必须遵从驼峰形式
    

    ####6.常量

      使用全大写英文命名,多个单词需要以下划线分开
    

    ####7.空行规则

      1.每个函数,类或者业务逻辑不同的代码块之间进行空行隔开;
      2.大括号使用方法为:左大括号之前不空行,之后空行,右大括号前空行,之后除else之外空行,表示终止时必须空行
    

    ####8.常量

      使用全大写英文命名,多个单词需要以下划线分开
    

    ####9.注释规则

      类前,函数前必写注释进行解释,重要业务逻辑代码块前进行注释
    

    ####10.操作符前后空格

      操作符前后一律加上一个空格
    

    ####11.其他规则 暂无