This article outlines: Special annotation technology in the code--todo, Fixme and the use of XXX.
Objective:
Today when reading the source code of Qt Creator, found some comments have fixme English words, in English dictionary actually can't find its meaning!
In fact, when we read some open source code, we often encounter words such as TODO, fixme, and XXX, which have their special meanings. 、
TODO: + Description :
If the code has the identity, the function code at the identification is to be written, the functionality to be implemented is briefly described in the description.
fixme: + Description :
If the code has the identity, the code needs to be corrected, even the code is wrong, not working, need to fix, how to fix it in the description is briefly described.
XXX: + Description :
If the code has the identity, the code at the point of identification, although the implementation of functionality, but the implementation of the method to be discussed, I hope to improve in the future, where the improvement will be briefly described in the description.
Special comments in Eclipse:
In Eclipse, TODO, fixme, and XXX are all collected by the task view of Eclipse. It is a good practice to check the task view before the project is released. In addition, in Eclipse, we can customize our own special comment tags. For example, the Window->preferences->c/c++->task tags window allows you to add special tags to the default only Todo, Fixme, and XXX.
Transferred from: http://www.cnblogs.com/pengyingh/articles/2445826.html
Special annotation techniques in the code--todo, Fixme and the use of XXX