代码注释最佳实践

特殊标记注释

• TODO - 在该注释处有功能代码待编写，待实现的功能在说明中会简略说明
• FIXME - 在该注释处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明
• XXX - 在该注释处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明
• NOTE - 在该注释处说明代码如何工作
• HACK - 在该注释处编写得不好或格式错误，需要根据自己的需求去调整程序代码
• BUG - 在该注释处有 Bug

// TODO功能未完成，待完善
// FIXME  待修复
// XXX    实现方法待确认
// NOTE   代码功能说明
// HACK   此处写法有待优化
// BUG    此处有 Bug
const arr = []

参考阅读

• 编写高质量可维护的代码：一目了然的注释