Objective:
Today, in reading the source code of Qt Creator, I found that some of the comments have fixme English words, in English dictionaries can not find its meaning.
In fact, when reading some open source code, we often encounter words like TODO, fixme, and XXX, which have special meanings. 、
TODO: + Description :
If the identity is in the code, the function code is written at the identity, and the functionality to be implemented is briefly described in the description.
fixme: + Description :
If the ID is in the code, the identification code needs to be fixed, or even the code is wrong, cannot work, needs to be repaired, and how the correction is explained briefly in the description.
XXX: + Description :
If the code has the identity, the identification code, although the implementation of the functionality, but the implementation of the method to be discussed, I hope to improve in the future, to improve the place will be briefly described in the description.
Special notes in Eclipse:
In Eclipse, TODO, fixme, and XXX are all collected by the task view of Eclipse. Before the project is released, it is a good practice to check the task view. In addition, in Eclipse, we can customize our own special annotation tags. such as in C + +, enter the Window->preferences->c/c++->task tags window can add special tags, the default only Todo, Fixme and XXX.
The following features are available in the Task window and can be clicked to locate the specified code section. More convenient. As shown in figure: