代码中特殊注释——TODO、FIXME、XXX、HACK
TODO 待办事项。若代码中有这个标识,则说明此处代码还未完成,待完成的功能会在说明中简略说明。
XXX 此标识说明代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
HACK 英语翻译为砍,如果代码中有该标识,说明标识处代码是我们需要根据自己的需求去调整程序代码。
FIXME 可以拆解成短语,fix me,意为修理我。若代码中有该标识,说明标识代码需要修改,甚至是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
NOTE 汝等凡人
Description of how the code works (when it isn’t self evident)
BUG: 丢锅埋雷挖坑
There is a problem here.