欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-07-05 10:44:18
    写出自解释文档代码,然后让这部分歇息吧。这不是说着玩。     使用英文编写注释。  ...


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

    避免多余的注释。

  # 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 或者类似的地方注明。