编程中的惯例

发表于 更新于 分类于 本文字数： 262 阅读时长 ≈ 1 分钟

本文记录一下编程中的一些约定俗成的惯例：

在代码中类似FIXME、TODO的code comments

  • NOTE：描述代码如何工作（当代码功能不显然的时候）
  • XXX：警告可能的陷阱，可以用作NOTE:XXX:
  • HACK：代码写的不好或者代码变形可能导致bug，应该用作HACK:FIXME
  • FIXME：代码可以工作，但是可以改进（通常用于代码写得很匆忙需要重写）
  • BUG：有问题
  • TODO：没有问题，但是要额外的代码需要编写，通常用于跳过某些功能的实现时。

参考资料：

  1. What is the meaning of #XXX in code comments?