编程基础之特殊注释标记 TODO && FIXME && XXX

在编写代码的时候，我们可以利用一些公认的特殊注释标记（TODO && FIXME && XXX）快速简洁地表达自己的目地。并且大多数的 IDE 都可以根据这些注释标记检测到相应的代码块以进行后续的编码工作，防止遗漏。

TODO: <说明>

通常写在函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。

TODO 注释标记表示 >>>> 该注释标识处代码块，有一些代码功能还未实现，当前不实现，未来会实现。<说明> 中应简要描述该功能。

FIXME: <说明>

FIXME 注释标记表示 >>>> 该注释标记处的代码块有问题或者是错误的，有可能无法正常工作，是需要进行修复的（BUG）。<说明> 中应简要描述下问题的修复思路。

XXX: <说明>

XXX 注释标记表示 >>>> 该注释标记处的代码块功能虽然实现了，但是实现的方式可能并不那么的好，可以进行一些改进优化。<说明> 中应简要描述下后续改进优化的策略。

---

Demo

Java

// TODO: 未来将实现的功能。
// FIXME: 该部分代码问题的修复思路。
// XXX: 该部分代码后续改进优化的策略。

或者

/*
    TODO: 未来将实现的功能。
    FIXME: 该部分代码问题的修复思路。
    XXX: 该部分代码后续改进优化的策略。
*/

Python

# TODO: 未来将实现的功能。
# FIXME: 该部分代码问题的修复思路。
# XXX: 该部分代码后续改进优化的策略。

或者

'''
	TODO: 未来将实现的功能。
	FIXME: 该部分代码问题的修复思路。
	XXX: 该部分代码后续改进优化的策略。
'''

---