Ruby编程规约(下)

Ruby编程规约(上)

 

命名规约

全体

  1. 原则上 不使用单词的省略词

  2. 对于作用域小的循环变量 ,以 i, j, k 这样 的名字顺序使用

  3. 对于作用域小的变量名,可以使用类名的省略语 ( : eo = ExampleObject.new )

类名和模块名

类以及模块名 单词的每头一个字母大写 不要使用’ _’ (下划线)等分隔符 但是 HTTP 这样的通用缩略语,全都照样大写。

:

ExampleClass

HTTPClient

:

Example_Class

EXAMPLE_CLASS

HttpClient

HTTPclient

HTTP_Client

方法

方法 全都 小写 各个单词之间用’ _ 分隔 方法名中 使用动词的原形

:

add_something

:

addsSomething

Add_Something

返回真假值的方法的命名 在动词或形容词后追加’ ? 形容词 ,不用添加’ is_

:

visible?

:

is_visible

is_visible?

另外 在使用具有 破坏性和非破坏性的方法时候 ,要 在破坏性的方法名后追加’ !

:

split

split! # 具有破坏性的 split

常数名

模块 名以外 的常数名 用大写 单词之间用’ _ 来分隔

:

EXAMPLE_CONSTANT

变量名

对于变量名 全都 用小写 单词之间用’ _ 来分隔。

:

tmp

local_variable

@instance_variable

$global_variable

文件名

文件名全都使用小写字母 单词之间用’ _ 来分隔 另外 可以把文件中的已经变换的主要类名作为文件名来使用 ( 把模块作为命名空间来使用的时候,同时使用目录名,可以 表现出层次结构。 )

:

foo.rb # 定义了 Foo

foo-bar.rb # 定义了 FooBar

foo/bar-baz.rb # 定义了 Foo::BarBaz

Copyright (C) 2007 Shugo Maeda

licensed under Creative Commons Attribution License

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值