代码中特殊的注释技术——TODO、FIXME和XXX的用处（转）

2024-06-03 20:11:49

1、声明

本篇转自博客：http://blog.csdn.net/reille/

2、转载内容

2.1、前言

今天在阅读 Qt Creator 的源代码时，发现一些注释中有 FIXME 英文单词，用英文词典居然查不到其意义！
实际上，在阅读一些开源代码时，我们常会碰到诸如：TODO、FIXME 和 XXX 的单词，它们是有其特殊含义的

2.2、TODO: + 说明：

如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。

2.3、FIXME: + 说明：

如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。

2.4、XXX: + 说明：

如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。

2.5、eclipse 中特殊的注释：

在 eclipse 中，TODO、FIXME 和 XXX 都会被 eclipse 的 task 视图所收集。

在项目发布前，检查一下task视图是一个很好的习惯。

此外，在 eclipse 中，我们可自定义自己的特殊注释标签。

如在 C/C++中，进入window —> preferences —> C/C++ —>Task Tags 窗口即可添加特殊标签，默认只有 TODO、FIXME 和 XXX 。

3、最后

对于自己写的不太确定的部分，并且眼下又没有人来参与讨论，那么，可以用 XXX 的形式来标注，并且写一下当时的思路注解，这样上线前，检查一下，就不会因为忘记而造成一些不必要的麻烦。

代码中特殊的注释技术——TODO、FIXME和XXX的用处（转）相关推荐

代码中特殊的注释技术——TODO、FIXME和XXX的用处
为什么80%的码农都做不了架构师?>>> 在阅读一些开源代码时,我们常会碰到诸如:TODO.FIXME和XXX的单词,它们是有其特殊含义的. TODO: + 说明: 如果代码中 ...
Xcode代码中特殊的注释技术——TODO、FIXME和XXX的用法
转载至:http://blog.csdn.net/HookyStudent/article/details/41517779 TODO: + 说明: 如果代码中有该标识,说明在标识处有功能代码待编写, ...
java面试题25 在程序代码中写的注释太多，会使编译后的程序尺寸变大。
java面试题25 在程序代码中写的注释太多,会使编译后的程序尺寸变大. A:正确 B:错误蒙蔽树上蒙蔽果,蒙蔽树下你和我拿到这道题,我觉得说的贼有道理,注释太多,尺寸变大.无疑与就和驾考一样, ...
删除 java代码中所有的注释
删除 java代码中所有的注释.java public class CleanCommons {private static Pattern pattern = Pattern.compile(&qu ...
Python正则表达式工具类文件的封装实例，提供了多个实例，并且在代码中包含中文注释
Python正则表达式工具类文件的封装实例,提供了多个实例,并且在代码中包含中文注释 import reclass RegexUtils:'''正则表达式工具类'''def __init__(self ...
设计代码说明什么是多态性?如何实现多态?(代码中要写注释解释)_狗屎一样的代码！快，重构我...
关注后你就是我的人了重构不止是代码整理,它提供了一种高效且受控的代码整理技术. (一)重构原则 1.何谓重构对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修 ...
设计代码说明什么是多态性?如何实现多态?(代码中要写注释解释)_狗屎一样的代码！快，重构我！...
狗屎一样的代码如何重构? 重构不止是代码整理,它提供了一种高效且受控的代码整理技术. (一)重构原则 1.何谓重构对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低 ...
【错误记录】IntelliJ IDEA 中 Java 代码中的中文注释报错 ( Menu / File / Settings / Editor / File Encodings 中修改工程编码 )
文章目录一.报错信息二.解决方案一.报错信息在 IntelliJ IDEA 中 , 出现中文注释报错 ; Y:\002_WorkSpace\003_IDEA\Groovy_Demo\src\m ...
被通知一个月离职，我修改了项目中的所有注释……
Hollis的新书限时折扣中,一本深入讲解Java基础的干货笔记! 整理|燕珊.核子可乐来源|InfoQ 当冲突爆发且到了必须让程序员离开时--那让他们"及时离开"吧. 假如你已 ...

最新文章

热门文章