`
linshihao
  • 浏览: 8031 次
  • 性别: Icon_minigender_1
  • 来自: 深圳
社区版块
存档分类
最新评论

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

阅读更多
本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处。

本文内容概要: 代码中特殊的注释技术——TODO、FIXME和XXX的用处。
前言:
今天在阅读Qt  Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!
实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO、FIXME和XXX的单词,它们是有其特殊含义的。、

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

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

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

eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX。
分享到:
评论

相关推荐

    汇总所有代码注释(如TODO或FIXME)的工具-Node.js开发

    代码注释代码注释是Rails的“ ...代码注释基于两个npm模块,主要来自fixme,但也受节点注释的启发。 该模块的主要区别是:灵活定义源扫描目录传递与multimatch兼容的排除模式的能力从.gitignore f中读取排除列表的能力

    小案例——todo-list以及单测

    在这个“小案例——todo-list以及单测”中,我们将探讨如何构建一个简单的待办事项(Todo List)应用程序,并为其编写单元测试。单元测试是软件开发中的一个重要环节,它确保代码的各个部分按照预期工作,提高了代码...

    Vim中列出TODO与FIXME等备注的方法

    在开发过程中,程序员常常会在代码中使用特定的关键字(如TODO, FIXME, HACK等)作为注释的一部分,以此来标记那些需要后续关注或修改的地方。这些关键字有助于提高代码的可读性和可维护性,但在实际操作中,如果...

    Redux入门实战——todo-list2.0实现.7z

    在`Redux入门实战——todo-list2.0实现`的压缩包中,你可能会找到以下文件: - `index.js`: 应用入口,包含`Provider`组件和应用根组件。 - `App.js`: 主应用组件,可能包含了`TodoList`和`TodoForm`等子组件。 - `...

    leasot:从文件中的注释中解析并输出TODO和FIXME

    轻松提取,收集和报告代码中的TODO和FIXME。 该项目使用正则表达式以便从注释中提取您的待办事项。 评论格式 TODO: add some info 空格是可选的。 冒号是可选的。 必须在其自己的行中的注释(行或块)中( some ...

    微信小程序——提醒录todo list(截图+源码).zip

    微信小程序——提醒录todo list(截图+源码).zip 微信小程序——提醒录todo list(截图+源码).zip 微信小程序——提醒录todo list(截图+源码).zip 微信小程序——提醒录todo list(截图+源码).zip 微信小程序...

    todo-list:在您的项目中查找 TODO、NOTE 和 FIXME。 按受让人和文件排序

    待办事项列表 Todo-list 启动一个服务器来查找 TODO、FIXME 和 NOTEs,将它们呈现在一个界面中,让您可以按受让人和文件进行排序。 服务器还将显示代码片段。作为应用程序使用Todo-list 可以作为应用程序安装和使用...

    注释代码的13条注意事项

    这样的注释冒犯了作者,而且你并不知道谁会在将来读到这段注释——你老板、客户或者是你在注释中冒犯的那个可怜且愚蠢的开发人员。 6. Get to the point(简明扼要) 不要在注释中写的过多,不要写玩笑、诗和冗长...

    broccoli-leasot:一个西兰花插件,它包裹了leasot模块,以解析和输出文件注释中的TODO和FIXME

    一个西兰花插件和一个模块的余烬插件,用于从注释中解析和输出标记(如TODO和FIXME) 回购健康和统计 安装 npm install --save-dev broccoli-leasot 截屏 用法 var broccoliLeasot = require ( 'broccoli-leasot' ...

    Go-astitodo:一个Golang库和CLI来解析GO代码中的TODO

    Go-astitodo 是一个基于 Golang 的工具,它的主要功能是帮助开发者解析和管理 GO 代码中的 TODO 注释。这个工具提供了库的形式,可以方便地集成到其他项目中,同时还有一个命令行界面 (CLI) 版本,使得开发者可以...

    SublimeLinter-annotations, 标记注释FIXME等注释的SublimeLinter 3插件.zip

    SublimeLinter-annotations, 标记注释FIXME等注释的SublimeLinter 3插件 sublimelinter注释 这个用于SublimeLinter插件的linter插件强调注释中注释,注释,TODO,@todo, XXX,以及自述文件。 它将与所有文件一起使用...

    Ruby-在代码中编写TODO以确保您能够实际执行它们

    在Ruby编程语言中,"TODO"是一个常见的注释标记,用于提醒开发者某个部分的代码需要进一步的工作或改进。"在代码中编写TODO以确保您能够实际执行它们"这个主题强调了在开发过程中有效管理和跟踪待办事项的重要性。...

    todocheck:带有注释的TODO注释的静态代码分析器

    您将再也不会发现散布在您的代码库中的奥秘,未记录的TODO注释。 有关更多信息,请参。 目录 GitLab 怎么运行的 这是带注释的TODO的示例: // TODO J123: Fix this typo func fuu() { ... } 如果链接的问题J123是...

    经典的todo小项目 全部用代码写的

    【标题】"经典的todo小项目 全部用代码写的" 涵盖了软件开发中的一个基础且实用的应用——Todo List。这个项目是许多初学者入门编程或学习新语言时首选的实战练习,因为它简单易懂,同时又能涵盖基本的编程概念和...

    小程序源码 todo list (代码+截图)

    小程序源码 todo list (代码+截图)小程序源码 todo list (代码+截图)小程序源码 todo list (代码+截图)小程序源码 todo list (代码+截图)小程序源码 todo list (代码+截图)小程序源码 todo list (代码+截图)小程序...

    提高代码可读性的10个注释技巧

    在团队开发中,使用特定标签(如TODO、FIXME等)来标记需要特别注意的地方是非常有帮助的。这些标签可以帮助团队成员快速定位问题所在。 #### 技巧9:及时添加注释 最好在编写代码的同时添加注释,因为此时你对...

    git-pending:Git插件,用于在存储库中列出TODO,FIXME,TESTME,DOCME注释

    pending Git插件列出待办事项,修订,测试和文档注释以及详细信息安装运行以下命令以安装插件npm install - g git - pending用法打开任何git存储库并运行以下命令git pending 这将列出所有待处理的TODO , FIXME ,...

    android开发的todo_list源代码

    在Android开发中,`Todo_list`是一个常见的学习项目,它帮助开发者掌握基本的用户界面设计、数据存储和事件处理等核心技能。这个项目是基于Java或Kotlin语言实现的,通常包括以下几个关键知识点: 1. **Activity与...

    verify-todo:验证源代码中的TODO注释是否包含指向问题的链接

    验证待办事项具有链接验证// TODO代码中的// TODO注释是否包含指向Github问题的链接或匹配您指定的模式。 它不会代表您创建票证-而是验证票证链接已添加到TODO。基本用法一个简单的工作流程脚本如下所示: name: ...

Global site tag (gtag.js) - Google Analytics