Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 1.33 KB

Java代码规范.md

File metadata and controls

43 lines (22 loc) · 1.33 KB

代码规范(Java)

  • 缩进

    缩进使用4个空格(Tab)

  • 变量命名

    变量名采用lowerCamelCase风格,使用驼峰命名法,变量名只包含字母和数字,首个单词首字母大写,后面单词首字母小写,有数字的话在最后。使用有意义的名字作为变量名方便阅读代码(作用域很小的临时变量使用 i、j、k....等命名方式),命名使用英文单词不使用拼音

  • 每行最多字符数

    一行最多只有一个语句,一行最多不超过100个字符

  • 函数最大行数

    单个函数最多包含50行代码

  • 函数、类命名

    函数命名采用lowerCamelCase风格,使用驼峰命名法,首个单词首字母大写,后面单词首字母小写,取有函数的功能作为函数名;类名采用UpperCamelCase风格,使用驼峰命名法,首字母大写,类名包含具体含义,可以指明一类事物。

  • 常量

    常量命名全部使用大写,单词之间使用‘ _ ’分隔

  • 空行规则

    不同的功能模块之间会留有空行,如函数之间,或函数内部不同部分之间会空行便于阅读。

  • 注释规则

    单行注释用//,短的注释直接跟在语句后面,长的注释另起一行

    多行注释使用/**/

  • 操作符前后空格

    操作符前后均留有一个空格

  • 其他规则

    ...