java中的特殊注释及说明

最新推荐文章于 2023-08-03 00:05:20 发布
最新推荐文章于 2023-08-03 00:05:20 发布
阅读量1.5k 收藏 3
点赞数
分类专栏： java 文章标签： java java基础
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34207366/article/details/84527083
版权

java中的特殊注释

  • 在阅读一些开源代码时，我们常会碰到诸如：TODO、FIXME的单词，它们是有其特殊含义的。
  • 本文主要介绍这些特殊注释的用处

1. TODO： + 说明：

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

2. FIXME：+ 说明：

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

说明

此类注释一般用于工作中对自己的工作做一些标记

Guohao_Chen
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
javacv-1.5.5.jar中文文档.zip
03-01
注：下文中的 *** 代表文件名中的版本号。 # 【javacv-***.jar中文文档.zip】 中包含： 中文文档：【javacv-***-javadoc-API文档-中文(简体)版.zip】 jar包下载地址：【javacv-***.jar下载地址(官方地址+国内镜像地址).txt】 Maven依赖：【javacv-***.jar Maven依赖信息(可用于项目pom.xml).txt】 Gradle依赖：【javacv-***.jar Gradle依赖信息(可用于项目build.gradle).txt】 源代码下载地址：【javacv-***-sources.jar下载地址(官方地址+国内镜像地址).txt】 # 本文件关键字： javacv-***.jar中文文档.zip,java,javacv-***.jar,org.bytedeco,javacv,***,cl.eye,jar包,Maven,第三方jar包,组件,开源组件,第三方组件,Gradle,bytedeco,中文API文档,手册,开发手册,使用手册,参考手册 # 使用方法： 解压 【javacv-***.jar中文文档.zip】，再解压其中的 【javacv-***-javadoc-API文档-中文(简体)版.zip】，双击 【index.html】 文件，即可用浏览器打开、进行查看。 # 特殊说明： ·本文档为人性化翻译，精心制作，请放心使用。 ·只翻译了该翻译的内容，如：注释、说明、描述、用法讲解 等； ·不该翻译的内容保持原样，如：类名、方法名、包名、类型、关键字、代码 等。 # 温馨提示： （1）为了防止解压后路径太长导致浏览器无法打开，推荐在解压时选择“解压到当前文件夹”（放心，自带文件夹，文件不会散落一地）； （2）有时，一套Java组件会有多个jar，所以在下载前，请仔细阅读本篇描述，以确保这就是你需要的文件； # Maven依赖： ``` <dependency> <groupId>org.bytedeco</groupId> <artifactId>javacv</artifactId> <version>***</version> </dependency> ``` # Gradle依赖： ``` Gradle: implementation group: 'org.bytedeco', name: 'javacv', version: '***' Gradle (Short): implementation 'org.bytedeco:javacv:***' Gradle (Kotlin): implementation("org.bytedeco:javacv:***") ``` # 含有的 Java package（包）： ``` cl.eye org.bytedeco.javacv ``` # 含有的 Java class（类）（此处仅列举3个）： ``` cl.eye.CLCamera org.bytedeco.javacv.AndroidFrameConverter org.bytedeco.javacv.BaseChildSettings ...... ```
JAVA的几种注释
weixin_48045037的博客
07-07 1051
JAVA的几种注释 region todo
代码中特殊的注释技术——TODO、FIXME和XXX的用处
淡定的米哥
01-29 348
TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: + 说明： 如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简...
Java特殊的代码注释XXX、TODO、FIXME以及自定义代码注释
诚
02-04 3732
TODO: + 说明：   如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明：   如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: + 说明：   如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明...
Java的几种注释
g4ilolii的博客
05-21 1429
Java的注释方法大致有以下三种： 1.// ……单行注释。 该种注释用于在写代码的时候对自己的代码进行标注，以方便自己和别人之后查看。以HelloWorld为例，代码如下 public class HelloWorld{ public static void main(String [] args){ System.out.println("HelloWorld ");//输出指令 }...
IntellJ IDEA 中JAVA代码的任务标记（TODO、FIXME、【XXX】）
热门推荐
炸鸡小子的博客
12-08 2万+
【任务标记是以注释的方式定义】 一、作用： 1、代码量非常大的项目，在某一行中需要在后续阶段实现一个功能，如果不标注下次再找的时候就非常困难了，可以大大的提高开发效率！ 2、在团队合作中，还可以告诉别人某处敏感代码的状态。 二、以下为常见的两种注释标记： 1、// TODO: 表示在此处将要实现的功能，提醒你在后续阶段将会在此处添加代码 2、// FIXME: 表示此处的代码逻辑有出入，或者根...
Java中的3种注释方法简述
最新发布
我都博客
08-03 2909
Java注释，总共有3种注释方法
Eclipse中Java代码注释XXX、TODO、FIXME的意义
I'm Learning!
11-27 1万+
今天看到一篇文章，谈到现在很多人学JAVA不会使用工具，比如TODO啊之类的，我一想其实我也不会，以前都是直接删除掉的，然后找了点资料看看，觉得这几个注释还是很有用的。 特殊注释： 1、 TODO 表示需要实现，但目前还未实现的功能 2 、XXX 勉强可以工作，但是性能差等原因 3 、FIXME 代码是错误的，不能工作，需要修复
如何在java中正确使用注释
08-25
"如何在Java中正确使用注释" 在 Java 编程中，注释是一种非常重要的组成部分。正确地使用注释可以使代码变得更加易读、易维护和易理解。按照惯例，一份规范的程序源代码中，注释应该占到源代码的 1/3 以上。 Java ...
Java代码注释规范详解
09-02
Java代码注释是编程实践中不可或缺的一部分，它有助于提高代码的可读性和维护性。下面将详细阐述Java代码注释的一些规范和最佳实践。 1. **注释形式统一**： - 保持一致性是关键。在同一个项目中，注释应该采用...
Java代码注释规范(动力节点整理)
08-30
Java代码注释规范是编程实践中不可或缺的一部分，它有助于提高代码的可读性和团队协作效率。以下是一些关于Java代码注释的基本原则和建议： 1. **注释形式统一**： - 在整个代码库中，应保持注释风格的一致性。这...
Java代码注释规范.docx
05-09
Java代码注释规范是软件开发中的一个重要组成部分，它不仅有助于提升代码的可读性和可维护性，还能增强团队间的协作效率。遵循良好的编码规范，可以帮助开发者形成良好的编程习惯，培养更加严谨的思维方式。下面将...
【廖雪峰官方网站/Java教程】注解
Allenlzcoder的博客
03-29 529
本节我们将介绍Java程序的一种特殊“注释”——注解（Annotation）。 1.使用注解 1.1.注解入门示例 什么是注解（Annotation）？注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”，如下例子： // this is a component: @Resource("hello") public class Hello { @Inject int n...
Java中的各种注释，你知道不同注释所代表的含义吗？
DBSDXQ_1024的博客
10-26 1523
是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性。注释只是为了提高可读性，不会被计算机编译。1、// 用于单行注释。2、/*...*/ 用于多行注释，从/*开始，到*/结束，不能嵌套。3、/**...*/ 则是为支持jdk工具 javadoc.exe 而特有的注释语句。这个也就是我们所知的文档注释。以双斜杠“//”标识，只能注释一行内容，一般用在需要注释信息内容比较少的地方。
“@” Java中的特殊符号——注解（Java中’@‘符号是什么意思？）
ITSM/ITIL/网络安全/IT运维
04-20 8371
在Java中经常看到这样的字眼 1.@Override 2.@Deprecated 3.@SuppressWarnings　　 4.@SafeVarargs 5.@FunctionalInterface 很多小伙伴不知道什么意思，其实这是一种注解，注意是注解 ，不是“ // ”注释哦。 1. 什么是注解（百度百科） 注解，可以看作是对 一个 类/方法 的一个扩展的模版，每个 类/方法 按照注解类中的规则，来为 类/方法 注解不同的参数，在用到的地方可以得到不同的 类/...
java中的各种注释说明及作用。
jibhikk的博客
09-24 1150
java中的各种注释说明及作用
Java的注释说明
weixin_33700350的博客
06-24 446
2019独角兽企业重金招聘Python工程师标准>>> ...
Java注解「详解」
weixin_56433857的博客
04-13 6983
注解（Annotation）是Java语言中的一种特殊语法结构，它可以在代码中嵌入元数据（metadata），用于一些特殊的标记和说明。注解可以在编译时被读取，并在运行时使用。@注解名称(属性名1=属性值1, 属性名2=属性值2, ...)其中，符号表示这是一个注解，注解名称是一个标识符，类似于Java中的类名或接口名。注解名称后面的括号中可以包含零个或多个属性，属性的格式是属性名=属性值，多个属性之间用逗号分隔。// ...此处使用了@Deprecated。
EL表达式字符串拼接
Mike的博客
12-19 1万+
在jsp中使用EL表达式拼接字符串的时候报500错误 下面我列出一个简单的例子 代码如下 &lt;!-- 举个例子 从controller层传了几个参数在当前jsp页面 id = 1 name = 阿豪 条件: 我们需要根据 state的值来动态的显示不同的信息 --&gt; &lt;div&gt;${name + "!"}&lt;/div&gt; &lt;div&gt;${id ...
java命名规范以及注释规范
07-21
2. 应该在类、方法、变量的前面使用注释说明其作用和用途。 3. 对于一些复杂的逻辑、算法要进行详细的注释，使其它人更容易理解。 4. 应该注明作者、时间、修改记录等信息，方便维护和管理。 最后，要注意在编写...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值