收藏本站 收藏本站
积木网首页 - 技术学院 - 软件测试 - 网站黄页 - 常用手册 - 站长工具 - 技术社区
首页 > ruby > 正文

首页 - PHP - 数据库 - 操作系统 - 游戏开发 - JS - Android - MySql - Redis - MongoDB - Win8 - Shell编程 - DOS命令 - jQuery - CSS样式 - Python - Perl

Access - Oracle - DB2 - SQLServer - MsSql2008 - MsSql2005 - Sqlite - PostgreSQL - node.js - extjs - JavaScript vbs - Powershell - Ruby

编写Ruby代码注释时需要注意的一些问题


写出自解释文档代码,然后让这部分歇息吧。这不是说着玩。
使用英文编写注释。
使用一个空格将注释与符号隔开。
注释超过一个单词了,应句首大写并使用标点符号。句号后使用 一个空格

避免多余的注释。

  # bad
  counter += 1 # increments counter by one

随时更新注释,没有注释比过期的注释更好。

不要为糟糕的代码写注释。重构它们,使它们能够“自解释”。(Do or do not - there is no try.)

注解应该写在紧接相关代码的上方。
注解关键字后跟一个冒号和空格,然后是描述问题的记录。

如果需要多行来描述问题,随后的行需要在 # 后面缩进两个空格。

  def bar
   # FIXME: This has crashed occasionally since v3.2.1. It may
   # be related to the BarBazUtil upgrade.
   baz(:quux)
  end

如果问题相当明显,那么任何文档就多余了,注解也可以(违规的)在行尾而没有任何备注。这种用法不应当在一般情况下使用,也不应该是一个 rule。

  def bar
   sleep 100 # OPTIMIZE
  end

使用 TODO 来备注缺失的特性或者在以后添加的功能。

使用 FIXME 来备注有问题需要修复的代码。

使用 OPTIMIZE 来备注慢的或者低效的可能引起性能问题的代码。

使用 HACK 来备注那些使用问题代码的地方可能需要重构。

使用 REVIEW 来备注那些需要反复查看确认工作正常的代码。例如: REVIEW: 你确定客户端是怎样正确的完成 X 的吗?

使用其他自定义的关键字如果认为它是合适的,但是确保在你的项目的 README 或者类似的地方注明。

Ruby中的异常处理代码编写示例
单个异常使用fail关键字仅仅当捕获一个异常并且反复抛出这个异常(因为这里你不是失败,而是准确的并且故意抛出一个异常)。beginfail'Oops'rescue=errorraise

Ruby中的集合编写指南
倾向数组及哈希的字面表示法(除非你需要传递参数到它们的构造函数中)。#badarr=Array.newhash=Hash.new#goodarr=[]hash={}当你需要元素为单词(没有空格和特殊符

浅析Ruby中的正则表达式的使用
如果只是需要中查找字符串的text,不要使用正则表达式:string['text']针对简单的结构,你可以直接使用string[/RE/]的方式来查询.match=string[/regexp/]#getcontentofmat

本周排行

更新排行

强悍的草根IT技术社区,这里应该有您想要的! 友情链接:b2b电子商务
Copyright © 2010 Gimoo.Net. All Rights Rreserved  京ICP备05050695号