Skip to content

Latest commit

 

History

History
43 lines (35 loc) · 1.31 KB

codestyle.md

File metadata and controls

43 lines (35 loc) · 1.31 KB

缩进:

  • 使用Tab键进行缩进
  • 关键字后留一个空格,便于阅读
  • 程序代码之间使用一个Tab键
  • 使用Sublime

变量命名

  • 匈牙利命名法
  • 变量名=属性+类型+对象描述
  • 其中每一个对象的名称都要求有明确含义,可以是对象名字全程或者一部分,同是要基于容易记忆理解的原则

每行最多字符数

  • 每一行最多字符数100
  • 对于长的需要在合适位置使用一个换行符

函数最大行数

  • 控制在100行以内
  • 尽量将功能模块化

函数、类命名

  • 使用英文命名
  • 使用下划线扩展

常量

  • 使用字母
  • 用数字与下划线进行扩展

空行规则

  • 函数之间空行
  • 循环之间空行
  • 代码模块之间空行

注释规则

  • 注释应该使代码更加清晰易懂
  • 注释要简洁明了,只要提供能够明确理解程序必要的信息就可以了。如果注释太复杂会影响程序整洁度和阅读感。
  • 注释不仅描述程序作了什么,还要描述为什么这样做以及约束。
  • 类、函数、列表、全局变量必须添加注释。
  • 简单注释一般不超过10个字。

操作符前后空格

  • 二元运算符的前后需要一个空格
  • 一元运算符与操作数之间不需要空格
  • 类或者对象访问符前后不需要空格