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

从解释文档中编写代码ruby 批量注释，然后让这部分休息. 不是要玩.

用英语写笔记.

使用空格分隔注释和符号.

该评论包含多个词. 大写句子并使用标点符号. 在句点之后使用空格

避免多余的评论.

  # bad
  counter += 1 # increments counter by one

随时更新评论. 没有评论比过期评论更好.

请勿撰写有关错误代码的评论. 重构它们，以便它们可以“自我解释”. （做或不做-没有尝试. ）

评论应直接写在相关代码的上方.

注释关键字后跟一个冒号和一个空格ruby 批量注释，然后是描述问题的记录.

如果需要用多行代码来描述问题，则需要在#后面的两个空格处缩进后面的行.

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

如果问题很明显，则任何文档都是多余的，并且该行末尾的注释（违反）可以不加任何注释. 在正常情况下，不应使用此用法，也不应作为规则.

  def bar
   sleep 100 # OPTIMIZE
  end

使用TODO记录将来缺少的功能或增加的功能.

使用FIXME记录有需要修复的问题的代码.

使用OPTIMIZE记录可能会导致性能问题的慢速或低效率代码.

使用HACK指出问题代码可能需要重构.

使用REVIEW记录需要重复检查以确认其正常工作的代码. 例如: REVIEW: 您确定客户端如何正确完成X吗？

如果您认为合适，请使用其他自定义关键字，但请确保在项目的自述文件或类似文件中进行说明.

本文来自电脑杂谈，转载请注明本文网址：
https://www.pc-fly.com/a/jisuanjixue/article-274646-1.html