`
我改名了
  • 浏览: 89509 次
  • 性别: 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。

分享到:
评论

相关推荐

    删除代码中的注释

    在编程世界中,注释是源代码的重要组成部分,它们用于解释代码的功能,帮助开发者理解和维护程序。然而,在某些情况下,如构建最小化可部署的代码或优化代码性能时,可能会有需求移除代码中的注释。这个过程被称为...

    去除注释 去注释

    本篇文章将详细探讨如何去除C++代码中的单行注释(//注释)和多行注释(/**/注释),以及可能涉及到的相关技术。 首先,我们要理解C++中的注释结构。单行注释以`//`开始,直到行尾结束;而多行注释则以`/*`开始,`*...

    删除源代码注释

    本主题将深入探讨如何批量删除C/C++源代码中的注释,以及涉及到的相关技术。 首先,我们需要了解C/C++语言中的注释类型。主要有两种: 1. 单行注释:以`//`开始,到行尾结束。例如: ```cpp // 这是一个单行注释...

    代码注释生成器.rar

    在当今的软件开发中,代码注释的重要性不言而喻。它不仅有助于提升代码的可读性,还能够在团队协作和长期维护中发挥关键作用。然而,手写注释的过程往往耗时且枯燥,这便是“代码注释生成器”出现的原因。这款工具的...

    STM32 启动代码注释分析

    ### STM32启动代码注释分析 #### 一、引言 在嵌入式系统开发过程中,理解微控制器(如STM32)的启动过程至关重要。本文将详细解析STM32启动代码的主要部分,帮助读者深入理解STM32启动机制。 #### 二、STM32启动...

    C#开发注释规

    C#编程语言在开发过程中,良好的注释习惯是确保代码可读性、可维护性和团队协作效率的关键。本文档旨在定义一套完整的C#开发注释规范,涵盖注释的内容、格式以及适用场景,帮助开发者遵循统一的标准,提升代码质量。...

    怎么在.js文件里写中文注释

    1. **避免中文标点符号**:尽管在注释中使用中文标点符号在技术上是可行的,但由于不同环境对中文标点的支持程度不一,建议使用英文标点符号以确保兼容性。 2. **代码风格指南**:对于团队项目而言,最好制定一套...

    Linux源代码注释

    ### Linux源代码注释——操作系统基础与进程管理 #### 操作系统存在基础 在深入了解Linux源代码之前,我们首先需要明确一点:操作系统之所以存在,是因为它解决了计算机硬件资源的管理和调度问题,使得用户可以...

    C注释&标签规则.pdf

    - OCR 技术在文档识别过程中可能出现字识别错误或遗漏,编译者需具备一定的理解能力,确保生成的注释内容准确无误。 ### 总结 在 C 语言开发中,遵循注释和标签规则对于创建易于理解和维护的代码至关重要。...

    javadoc 生成注释 和 检查注释的文档

    在Java源代码中,JavaDoc注释以`/**`开头,`*/`结尾,位于你想要为其生成文档的元素之前。例如,对于一个类: ```java /** * 这是一个简单的示例类,用于展示JavaDoc的使用。 */ public class SimpleExample { /...

    注释转换机

    在编程世界中,注释是源代码中不可或缺的一部分,它为其他开发者提供了理解代码功能和逻辑的线索。C++和C语言虽然有许多相似之处,但它们的注释风格却有所不同。C++支持单行和多行注释,而C语言只支持单行注释(始于...

    java文档注释要求

    在软件开发领域,编写高质量的代码不仅是技术实力的体现,更是职业素养的重要标志之一。其中,文档注释(JavaDoc Comments)作为源代码的一部分,对于提升项目的可维护性和可读性具有不可忽视的作用。本文将详细介绍...

    Java写的双色球选号+银行密码产生源代码 详细注释

    在源代码中,详细注释是非常重要的,它可以帮助读者理解每一部分代码的功能和工作原理。对于初学者,阅读并理解注释可以帮助他们更快地掌握编程概念和技术。在Java中,注释可以使用`//`单行注释或`/* */`多行注释来...

    基于MATLAB的LSTM文本分类代码(100%可用含中文注释)

    LSTM是一种特殊的循环神经网络(RNN),它解决了传统RNN在网络训练过程中可能出现的梯度消失或梯度爆炸问题。LSTM通过引入门控机制(输入门、遗忘门和输出门)来控制信息的流动,从而能够记住长期依赖关系,这使得...

    C语言注释删除

    在提供的压缩包文件中,"注释"可能是实现这一功能的源代码文件,通过阅读和分析这部分代码,可以进一步了解如何运用编译原理和C语言技术来实现注释删除的功能。对于初学者,这是一个很好的实践机会,不仅可以加深对...

    aps.net中的各种尖括号解释和代码分离技术探讨

    ### ASP.NET中的尖括号解释与代码分离技术探讨 #### 一、尖括号的含义与用法 在ASP.NET开发过程中,我们会遇到多种不同类型的尖括号指令,每种指令都有其特定的功能和用途。 1. ****:此指令用于数据绑定,是一种...

    freemarker java模板技术 很详细的注释

    让我们深入探讨一下Freemarker在Java模板技术中的重要性和相关知识点。 1. **Freemarker的基本概念** - **模板**: 模板是Freemarker的核心,它是HTML或其他文本格式的静态部分,其中包含了一些特殊的Freemarker...

    TreeGrid.dll 和特殊字符过滤代码

    `特殊字符过滤代码` 指的是编程中用于检查和处理输入数据中可能存在的不安全或非法字符的代码段。在处理用户输入时,为了防止SQL注入、跨站脚本(XSS)攻击或其他安全风险,开发者需要确保数据中不包含可能导致系统...

    pxcook前端注释工具

    PxCook提供了便捷的注释功能,开发者可以快速地对页面元素添加注释,明确标注各个组件的功能、位置关系或者特殊设计要求。这样,即使在复杂的项目中,团队成员也能清晰理解设计布局,提高协作效率。 3. **颜色取样*...

    jsp数据库连接大全(代码分色+注释)版本

    在这个压缩包中,提供的可能是通过JDBC(Java Database Connectivity)进行数据库操作的示例代码,包括代码分色和注释,以帮助学习者更好地理解和使用。 描述中提到的"Sql Server7.0/2000"是指微软公司的关系型...

Global site tag (gtag.js) - Google Analytics