代码中特殊注释
在阅读一些开源代码时,常会在注释中碰到诸如:TODO、FIXME 和 XXX
的单词,它们是有其特殊含义的。在编写代码的时候我们可以利用这些公认的特殊注释方式快速简介表达自己的目地。
TODO: <说明>
1 | 常出现在一些函数的上方或者内部,它表示该注释标识处,有一些代码功能还未实现,未来会实现。 |
FIXME: <说明>
1 | 如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,有可能无法正常工作,需要修复, |
XXX: <说明>
1 | 如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,将来可以进行一些改进优化, |