编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义

特殊注释

在编写代码的时候我们可以利用一些公认的特殊注释方式快速简介表达自己的目地

TODO: <说明>

通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。

FIXME: <说明>

该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。

XXX: <说明>

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

示例

Golang 中

// TODO: 将实现的功能
// FIXME: 如何修复该部分代码问题
// XXX: 如何改进优化该部分代码

或者

/*
	TODO: 将实现的功能
	FIXME: 如何修复该部分代码问题
	XXX: 如何改进优化该部分代码
*/

Python 中

# TODO: 将实现的功能
# FIXME: 如何修复该部分代码问题
# XXX: 如何改进优化该部分代码

或者
 
Python中的符号 ' 和 " 都表示字符串
'''
	TODO: 将实现的功能
	FIXME: 如何修复该部分代码问题
	XXX: 如何改进优化该部分代码
'''
或者
"""
	TODO: 将实现的功能
	FIXME: 如何修复该部分代码问题
	XXX: 如何改进优化该部分代码
"""