Special annotation Technology in code-the use of todo, fixme, and XXX (reprinted)

From: http://blog.csdn.net/reille/article/details/7161942

 

Reille

This blog website is http://blog.csdn.net/reille/. For more information, see this blog.

Summary: The use of todo, fixme, and XXX, a special annotation Technology in the code.

More please note: http://velep.com/

-------------------------------------------------------------------

Preface:
Today, when I read the source code of QT creator, I found some notes containing fixme English words, which cannot be found in the English dictionary!
In fact, when reading some open-source code, we often encounter words such as todo, fixme, and XXX, which have their special meanings. ,

Todo: + description:
If the Code contains this identifier, it indicates that there is a functional code to be written at the identifier, and the features to be implemented will be briefly described in the description.

Fixme: + description:
If this identifier exists in the code, it indicates that the code at the identifier must be corrected, or even the code is incorrect. If it cannot work, it must be fixed. How to fix it is briefly described in the description.

XXX: + description:
If the Code contains this identifier, it indicates that although the code in the identifier has implemented the function, the implementation method remains to be discussed. If you want to improve it in the future, the improvements will be briefly described in the description.

Special notes in Eclipse:
In eclipse, todo, fixme, and XXX are collected by the task view of Eclipse. It is a good habit to check the task view before the project is released. In addition, in eclipse, We can customize our own special annotation labels. For example, in C/C ++, enter WINDOW> preferences> C/C ++> task tags to add special labels. By default, only todo, fixme, and XXX are available.