Special annotation techniques in the code--todo, Fixme and XXX (reprint)

Transferred from: http://blog.csdn.net/reille/article/details/7161942

　　

Reille

This blog site: http://blog.csdn.net/reille/, reproduced this blog original article please indicate the source.

This article outlines: Special annotation technology in the code--todo, Fixme and the use of XXX.

More attention: http://velep.com/

———————————————————————————————————————————————————————————————————

Preface:
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 descriptionFunctional code at the logo to be written, the functionality to be implemented is briefly described in the description.

fixme: + Description：
If the code has the identity, the descriptionStandardThe code needs to be corrected, even if the code is wrong, not working, needs repairing, and how the fix will be explained briefly in the description.

XXX: + Description：
If the code has the identity, the description
Special comments in Eclipse:
in Eclipse, Moreover, in Eclipse, We can customize our own special annotation tags. such as in C + +, enter Window->preferences->c/c++- >Task tags window to add special tags, the default is only TODO, Fixme and XXX.

Special annotation Techniques in code--todo, Fixme, and XXX (reprint)