注释声明:TODO HACK XXX FIXME REVIEW
2016-08-08 09:35
393 查看
注释有时候也可以用来给一段代码声明额外的信息。这些声明的格式以单个单词打头并紧跟一个冒号。可以使用的声明如下。
这些声明可能在一行或者多行注释中使用,并且应当遵循同一般注释类型相同的格式规则。
参考:JavaScript编码风格指南(中文版)
TODO:说明代码还未完成。应当包含下一步要做的事情。
HACK:表明代码实现走了一个捷径。应当包含为何使用hack的原因。这也可能表明该问题可能会有更好的解决办法。
XXX:说明代码是有问题的并应当尽快修复。
FIXME:说明代码是有问题的并应尽快修复。重要性略次于XXX。
REVIEW:说明代码在任何可能的改动都需要评审。
这些声明可能在一行或者多行注释中使用,并且应当遵循同一般注释类型相同的格式规则。
参考:JavaScript编码风格指南(中文版)
相关文章推荐
- Java代码注释 XXX TODO FIXME 的意义
- eclipse中的特殊注释TODO FIXME XXX
- 代码中的TODO FIXME XXX 等注释释义
- Java代码注释XXX todo fixme 的意义
- Java代码注释XXX TODO FIXME 的意义
- 代码中的TODO FIXME XXX 等注释释义
- NOTE/XXX/HACK/FIXME/BUG/TODO
- Java代码注释XXX todo fixme
- 代码中 TODO FIXME XXX 注释的特殊含义
- Java代码注释XXX TODO FIXME 的意义
- //TODO //FIXME //XXX
- VS中特殊的注释——TODO/UNDONE/HACK的使用
- 代码中特殊注释——TODO、FIXME、XXX、HACK
- VS中特殊的注释——TODO/UNDONE/HACK的使用
- Swift和OC代码注释分析 #pragma mark, FIXME and TODO
- Swift和OC代码注释分析 #pragma mark, FIXME and TODO
- TODO XXX FIXME 自定义标签
- 代码中特殊的注释技术——TODO、FIXME和XXX的用处
- 代码注释___TODO__FIXME__XXX____提示
- 代码注释中TODO、FIXME和XXX的含义