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

脚本专栏 2025/1/9 佚名

3 1 2

清风细雨楼 Design By www.eepep.com

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

避免多余的注释。

  # 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,注释

清风细雨楼 Design By www.eepep.com

广告合作：本站广告合作请联系QQ：858582 申请时备注：广告合作（否则不回）
免责声明：本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除！

清风细雨楼 Design By www.eepep.com

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

暂无评论...

P70系列延期，华为新旗舰将在下月发布

3月20日消息，近期博主@数码闲聊站透露，原定三月份发布的华为新旗舰P70系列延期发布，预计4月份上市。

而博主@定焦数码爆料，华为的P70系列在定位上已经超过了Mate60，成为了重要的旗舰系列之一。它肩负着重返影像领域顶尖的使命。那么这次P70会带来哪些令人惊艳的创新呢？
根据目前爆料的消息来看，华为P70系列将推出三个版本，其中P70和P70 Pro采用了三角形的摄像头模组设计，而P70 Art则采用了与上一代P60 Art相似的不规则形状设计。这样的外观是否好看见仁见智，但辨识度绝对拉满。

更新日志

2025年01月09日

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

Ruby on Rails中的ActiveRecord编程指南

关于Ruby on Rails路由配置的一些建议

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

P70系列延期，华为新旗舰将在下月发布

更新日志

友情链接