代码中特殊注释——TODO、FIXME、XXX、HACK

在平时的编程中,总是能在一些编译器自动生成的代码或者大佬的程序中看到//TODO ...的注释,一直很疑惑到底是什么意思,以为是个注释规范,其实是项目管理者要求代码编写人员在式样无法确定,或者其他原因不能完成编程的时候,用// TODO进行注释,那么管理者就可以随时的通过任务列表查看工作状况和问题点来进行控制。

    在intellij中可以设置自己专属的TODO,设置自己专属的TODO表示用来在一个多人合作的项目中与别人的TODO分别开来(默认是深蓝色):

TODO:英语翻译为待办事项,备忘录。如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

FIXME:可以拆成短语,fix me ,意为修理我。如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

XXX:如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

HACK:英语翻译为砍。如果代码中有该标识,说明标识处代码我们需要根据自己的需求去调整程序代码。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容