美文网首页
关于Ruby代码的风格整理

关于Ruby代码的风格整理

作者: 织田信长 | 来源:发表于2016-07-18 22:02 被阅读44次

复制粘贴了一年的代码,是不是要有点自己的味道了。
源代码布局方面:
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、使用Rdoc生产系统的API文档,在注释和def之间不要有空行。
9、每行不超过80行
10、每行的结尾不要有空白字符。
语法方面:
1、一个方法如果没参数就省略括号,有参数就使用括号
2、如无必要,不要使用for,而使用each做循环
3、不要使用then
4、使用三元操作?:代替if,else。
5、不要在if else的内部使用?:操作符
6、使用when X then ...,因为when x ....在ruby1.9被删除了
7、使用&&和||做boolean操作,使用and,or做流程控制。
8、unless和else不要一起用
9、除非是判断条件涉及赋值操作,否则不不需要括起来
10、把多行语句块使用{}包含,
11、不需要使用的return的时候就不要用
12、不要使用‘'连接2行代码
13、使用||=来初始话变量,但是不能用来初始化boolean变量
14、不要使用perl风格的变量名,$1-9之类的
15、运行Ruby的时候,加上“-w”以提示我们代码中不好的地方
16、使用Ruby1.9的语法写lambda和hash
**命名规范: **
1、使用小写+“"命名变量和方法
2、使用首字母大写命名Module和Class
3、使用全大写+”
"命名常量
4、对于返回值是boolean的方法加个“?”后缀
5、对于一些有潜在风险的方法加“!”后缀,比方说有exit,修改了self,或者变量等等

相关文章

  • 关于Ruby代码的风格整理

    复制粘贴了一年的代码,是不是要有点自己的味道了。源代码布局方面:1、所有源文件以UTF-8编码2、使用2个空格的缩...

  • rubocop——ruby代码风格检查器

    rubocop——ruby代码风格检查器 rubocop 是Ruby代码风格自动检查工具,基于ruby-style...

  • rubocop 风格检查结果分析

    rubocop 作为ruby代码检查工具,对规范代码风格有很强的作用。使用 -D 参数会显示错误类型,方便总结归类...

  • 关于代码风格

    为什么强调代码风格 不同的语言,不同的项目,都有自己的风格,就像每个人都有自己的特点一样。代码风格是一个不容易引起...

  • RubyGems

    RubyGems 简介 用来打包和分享 ruby 代码。提供以下功能 ruby 打包代码的格式。 ruby 打包的...

  • Share Your Code

    昨天在Github上看代码时.看到Glist 里面关于一段关于Shell Execution in Ruby的实现...

  • C++代码风格整理

    1.缩进: 统一用4格 2.每行长度: 每行的长度不要超过80个字符,屏幕大可以扩大到120个字符 当函数的参数很...

  • 关于Java代码风格

    这篇总结了 Google Java Style 的大概内容。代码风格的统一是很重要的事情,不一样的风格往往造成阅读...

  • 微信小程序 - swiper 高度自适应

    我这边开发用的是 wepy,代码风格跟小程序原生的不太一样,下面代码是依照小程序的代码风格整理之后的,可能有不同或...

  • RuboCop

    什么是RuboCop Rubocop 是基于 ruby-style-guide / Ruby 风格指导 实现的一个...

网友评论

      本文标题:关于Ruby代码的风格整理

      本文链接:https://www.haomeiwen.com/subject/tbcmjttx.html