Ruby编程中的命名风格指南

2024-09-27 07:07:33

用英语命名标识符。

 # bad - identifier using non-ascii characters
  заплата = 1_000

  # bad - identifier is a Bulgarian word, written with Latin letters (instead of Cyrillic)
  zaplata = 1_000

  # good
  salary = 1_000

使用snake_case的形式给变量和方法命名。

 # bad
  :'some symbol'
  :SomeSymbol
  :someSymbol

  someVar = 5

  def someMethod
   ...
  end

  def SomeMethod
   ...
  end

  # good
  :some_symbol

  def some_method
   ...
  end

Snake case: punctuation is removed and spaces are replaced by single underscores. Normally the letters share the same case (either UPPER_CASE_EMBEDDED_UNDERSCORE or lower_case_embedded_underscore) but the case can be mixed

使用CamelCase(駝峰式大小寫)的形式给类和模块命名。(保持使用缩略首字母大写的方式如HTTP,
RFC, XML)

# bad
  class Someclass
   ...
  end

  class Some_Class
   ...
  end

  class SomeXml
   ...
  end

  # good
  class SomeClass
   ...
  end

  class SomeXML
   ...
  end

使用 snake_case 来命名文件, 例如 hello_world.rb。

以每个源文件中仅仅有单个 class/module 为目的。按照 class/module 来命名文件名，但是替换 CamelCase 为 snake_case。

使用SCREAMING_SNAKE_CASE给常量命名。

  # bad
  SomeConst = 5

  # good
  SOME_CONST = 5

在表示判断的方法名（方法返回真或者假）的末尾添加一个问号（如Array#empty?）。
方法不返回一个布尔值，不应该以问号结尾。

可能会造成潜在“危险”的方法名（如修改 self或者参数的方法，exit! (不是像 exit 执行完成项)等）应该在末尾添加一个感叹号如果这里存在一个该危险方法的安全版本。

 # bad - there is not matching 'safe' method
  class Person
   def update!
   end
  end

  # good
  class Person
   def update
   end
  end

  # good
  class Person
   def update!
   end

   def update
   end
  end

如果可能的话，根据危险方法（bang）来定义对应的安全方法（non-bang）。

  class Array
   def flatten_once!
    res = []

    each do |e|
     [*e].each { |f| res << f }
    end

    replace(res)
   end

   def flatten_once
    dup.flatten_once!
   end
  end

当在短的块中使用 reduce 时，命名参数 |a, e| (accumulator, element)。

  #Combines all elements of enum枚举 by applying a binary operation, specified by a block or a symbol that names a method or operator.
  # Sum some numbers
  (5..10).reduce(:+)              #=> 45#reduce
  # Same using a block and inject
  (5..10).inject {|sum, n| sum + n }      #=> 45 #inject注入
  # Multiply some numbers
  (5..10).reduce(1, :*)             #=> 151200
  # Same using a block
  (5..10).inject(1) {|product, n| product * n } #=> 151200

在定义二元操作符时，把参数命名为 other （<< 与 [] 是这条规则的例外，因为它们的语义不同）。

  def +(other)
   # body omitted
  end

map 优先于 collect，find 优先于 detect，select 优先于 find_all，reduce 优先于inject，size 优先于 length。以上的规则并不绝定，如果使用后者能提高代码的可读性，那么尽管使用它们。有押韵的方法名（如 collect，detect，inject）继承于 SmallTalk 语言，它们在其它语言中并不是很通用。鼓励使用 select 而不是 find_all 是因为 select 与 reject 一同使用时很不错，并且它的名字具有很好的自解释性。

不要使用 count 作为 size 的替代。对于 Enumerable 的 Array 以外的对象将会迭代整个集合来
决定它的尺寸。

  # bad
  some_hash.count

  # good
  some_hash.size

倾向使用 flat_map 而不是 map + flatten 的组合。
这并不适用于深度大于 2 的数组，举个例子，如果 users.first.songs == ['a', ['b', 'c']] ，则使用 map + flatten 的组合，而不是使用 flat_map 。
flat_map 将数组变平坦一个层级，而 flatten 会将整个数组变平坦。

  # bad
  all_songs = users.map(&:songs).flatten.uniq

  # good
  all_songs = users.flat_map(&:songs).uniq

使用 reverse_each 代替 reverse.each。reverse_each 不会分配一个新数组并且这是好事。

  # bad
  array.reverse.each { ... }

  # good
  array.reverse_each { ... }

GitHub倡导的Ruby代码编写风格总结

源代码布局方面: 1.所有源文件以UTF-8编码 2.使用2个空格的缩进 3.使用Unix风格的换行符(\n),windows(\r\n).可使用git config --global core.autocrlf true 防止产生windows风格的换行符. 4.在',',':'后,操作符(除指数操作之外),'{','}'的前后增加空格,增加代码的可读性. 5.在'(',')','[',']'符号后不要加空格. 6.Case和When处于同一代码层次. 7.2个def之间使用一个空行隔开 8.
浅析Ruby的源代码布局及其编程风格

使用 UTF-8 作为源文件编码. 每个缩进级别使用两个 spaces (又名软 tabs). 不要硬 tabs # bad - four spaces def some_method do_something end # good def some_method do_something end 使用 Unix-风格换行符.(*BSD/Solaris/Linux/OSX 用户被为默认涵盖,Windows 用户必须特别小心.) \n是换行,英文是LineFeed,ASCII码是0xA. \r是
你应该知道的Ruby代码风格

一.空格与tab使用空格缩进(95.364%)使用Tab缩进(4.636%)基于 1,001,987 次提交二.最大行宽80字符(92.618%)120字符(5.893%)150字符(1.489%)基于 1,057,374 次提交三.运算符.冒号.花括号周围,逗号.分号后是否使用空格不使用空格(73.366%) 复制代码代码如下: sum = 1 +2a,b = 1, 21>2 ? true : false;puts 'Hi'[1, 2, 3].each {|e| puts e} 使用空格(2
Ruby中编写类与模块的风格指南

在 class 定义里使用一致的结构. class Person # extend and include go first extend SomeModule include AnotherModule # constants are next SOME_CONSTANT = 20 # afterwards we have attribute macros attr_reader :name # followed by other macros (if any) validates :name
Ruby编程中的语法使用风格推荐

使用 :: 引用常量(包括类和模块)和构造器 (比如 Array() 或者 Nokogiri::HTML()). 永远不要使用 :: 来调用方法. # bad SomeClass::some_method some_object::some_method # good SomeClass.some_method some_object.some_method SomeModule::SomeClass::SOME_CONST SomeModule::SomeClass() 使用括号将de
Ruby编程中的命名风格指南

用英语命名标识符. # bad - identifier using non-ascii characters заплата = 1_000 # bad - identifier is a Bulgarian word, written with Latin letters (instead of Cyrillic) zaplata = 1_000 # good salary = 1_000 使用snake_case的形式给变量和方法命名. # bad :'some symbol' :Some
详解Java编程规约（命名风格、常量定义、代码格式）

命名风格 1.[强制]代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $name / name_ / name$ / name__ 2.[强制]代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式. 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义.注意,纯拼音命名方式更要避免采用. 正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视
初步讲解Ruby编程中的多线程

每个正在系统上运行的程序都是一个进程.每个进程包含一到多个线程. 线程是程序中一个单一的顺序控制流程,在单个程序中同时运行多个线程完成不同的工作,称为多线程. Ruby 中我们可以通过 Thread 类来创建多线程,Ruby的线程是一个轻量级的,可以以高效的方式来实现并行的代码. 创建 Ruby 线程要启动一个新的线程,只需要调用 Thread.new 即可: # 线程 #1 代码部分 Thread.new { # 线程 #2 执行代码 } # 线程 #1 执行代码实例以下实例展示了如何在
Ruby编程中关于中断和返回的用法教程

return,break,next 这几个关键字的使用都涉及到跳出作用域的问题,而他们的不同则在于不同的关键字跳出去的目的作用域的不同,因为有代码块则导致有一些地方需要格外注意. return 常用方式通常情况下的return语句和大家理解的意思是相同的. def m1 param if param == 1 return 'returned 1' end 'returned default value' # 根据Ruby语言规范,最后一条执行语句的结果将作为返回值返回,return是可选的
Ruby编程中的赋值相关操作

在老版本的Ruby中,赋值语句的返回值是设置该属性的方法的返回值.在Ruby1.8中,赋值语句的值总是参数的值而方法的返回值将被丢掉. class Test def val=(val) @val = val return 99 end end t = Test.new a = t.val=2 a ->2 在老版本中,a将被赋值语句设置为99,而在Ruby1.8中,它的值为2. Ruby的赋值实际是以并行方式执行的,所以赋值语句右边的值不受赋值语句本身的影响.在左边的任意一个变量或者属性被赋值之前
设计模式中的观察者模式在Ruby编程中的运用实例解析

观察者模式(有时又被称为发布/订阅模式)是软件设计模式的一种. 在此种模式中,一个目标对象管理所有相依于它的观察者对象,并且在它本身的状态改变时主动发出通知. 这通常透过呼叫各观察者所提供的方法来实现. 实现观察者模式的时候要注意,观察者和被观察对象之间的互动关系不能体现成类之间的直接调用,否则就将使观察者和被观察对象之间紧密的耦合起来, 从根本上违反面向对象的设计的原则.无论是观察者"观察"观察对象, 还是被观察者将自己的改变"通知"观察者,都不应该直接调用.
Go Web 编程中的模板库应用指南(超详细)

如果你有过Web编程的经验,那么或多或少都听说过或者使用过模板.简而言之,模板是可用于创建动态内容的文本文件.例如,你有一个网站导航栏的模板,其中动态内容的一部分可能是根据当前用户是否登录显示登录还是退出按钮. Go提供了两个模板库 text/template和 html/template.这两个模板库的使用方式是相同的,但是 html/template包在渲染页面模板时会在后台进行一些编码以帮助防止造成代码注入(XSS 攻击). 因为两个模板库都使用相同的接口,因此本文中介绍的所有内容均可用于
详解Ruby设计模式编程中对单例模式的运用

简介单例模式是设计模式中最简单的形式之一.这一模式的目的是使得类的一个对象成为系统中的唯一实例.要实现这一点,可以从客户端对其进行实例化开始.因此需要用一种只允许生成对象类的唯一实例的机制,"阻止"所有想要生成对象的访问.使用工厂方法来限制实例化过程.这个方法应该是静态方法(类方法),因为让类的实例去生成另一个唯一实例毫无意义. 要点显然单例模式的要点有三个:一是某个类只能有一个实例:二是它必须自行创建这个实例:三是它必须自行向整个系统提供这个实例.
JavaScript编码风格指南(中文版)

前言: 程序语言的编码风格对于一个长期维护的软件非常重要,特别是在团队协作中.如果一个团队使用统一规范的编码分风格,可以提高团队的协作水平和工作效率.编程风格指南的核心是基本的格式化规则,这些规则决定了如何编写高水准的代码.本指南来自于<编写可维护的JavaScript>这本书,基于"Java语言编码规范"和Crockford的JavaScript编程规范,还有Nicbolas的一些个人经验和喜好.写作本文旨在加深自己印象,也为了更多人的了解到JS编码风格,提高自己的编码质

Ruby编程中的命名风格指南

相关推荐

随机推荐