前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >注释声明:TODO HACK XXX FIXME REVIEW

注释声明:TODO HACK XXX FIXME REVIEW

作者头像
zhaokang555
发布2023-10-17 09:53:38
1650
发布2023-10-17 09:53:38
举报
文章被收录于专栏:赵康的日常专栏

注释有时候也可以用来给一段代码声明额外的信息。这些声明的格式以单个单词打头并紧跟一个冒号。可以使用的声明如下。

TODO: 说明代码还未完成。应当包含下一步要做的事情。

HACK: 表明代码实现走了一个捷径。应当包含为何使用hack的原因。这也可能表明该问题可能会有更好的解决办法。

XXX: 说明代码是有问题的并应当尽快修复。

FIXME: 说明代码是有问题的并应尽快修复。重要性略次于XXX。

REVIEW: 说明代码在任何可能的改动都需要评审。

这些声明可能在一行或者多行注释中使用,并且应当遵循同一般注释类型相同的格式规则。

参考:JavaScript编码风格指南(中文版)

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2016-08-08,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档