IMXYLZ

Ruby编码规范(建议)

Ruby由于是动态语言,如果代码没有规范将会带来很高的维护成本。

关于命名

  • 常量全部用大写字母,多个单词用下划线分隔
  • 类名和模块名称用大写字母开头,驼峰式命名
  • 方法名全部用小写字母,下划线分隔。另外方法名称后面可能跟着?和!. ?表示此方法仅返回boolean值true/false,!表示此方法可能会改变输入参数的值,具有破坏性。
  • 变量和参数可以用小写字母开头,驼峰式或者下划线分隔都可
  • 类名、模块名、变量、参数最好用名词或者“形容词+名词”,方法名最好是动词或者“动词+名称”。

关于空格和小括号

  • 关键字之后要留空格
  • 逗号(,)和分号(;) 之后要留空格,前面无须留空格
  • 比较操作符、复制操作符、算术操作符、逻辑操作符前后应当留空格
  • 一元操作符(!~) 前后无须留空格
  • ‘[]’、’.‘、’::‘等无须留空格
  • 函数名后面如果跟着小括号()就不留空白
  • 如果可以,尽可能的使用小括号,减少歧义

尽可能的使用return语句

类似于python,ruby的方法最后一条语句如果有返回值自动当作方法的返回值,如果没有返回值,那么方法就没有返回值。 显示的使用return有很多好处:

  • 明确告知方法返回的结果
  • 提前中断方法返回
  • 跳出多重循环或条件

最后的最后,注释当然是必不可少的,详细不罗嗦,清晰不简单。

Comments

回顶部