java中的特殊注释及说明

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

java中的特殊注释

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

1. TODO： + 说明：

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

2. FIXME：+ 说明：

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

说明

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

Java注释详解：从基础到高级应用
xycxycooo的博客
08-13 839
Java注释是提高代码可读性和可维护性的重要工具。通过合理使用单行注释、多行注释和文档注释，可以有效地解释代码的意图和逻辑，方便其他开发者理解和使用。同时，注释还可以用于代码调试、版本控制、代码审查和代码重构等高级应用场景。在实际编程中，应遵循注释的最佳实践，保持注释的简洁明了，及时更新注释，避免注释噪音。对于公共API，应使用文档注释生成详细的API文档，方便其他开发者使用。希望本文能为读者在Java注释的使用和应用方面提供有益的参考和启发，帮助读者编写出更清晰、更易维护的代码。
代码中特殊的注释技术——TODO、FIXME和XXX的用处
majian_1987的专栏
09-12 2123
前言： 今天在阅读Qt Creator的源代码时，发现一些注释中有FIXME英文单词，用英文词典居然查不到其意义！ 实际上，在阅读一些开源代码时，我们常会碰到诸如：TODO、FIXME和XXX的单词，它们是有其特殊含义的。、 TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，
Eclipse中Java代码注释XXX、TODO、FIXME的意义
热门推荐
I'm Learning!
11-27 1万+
今天看到一篇文章，谈到现在很多人学JAVA不会使用工具，比如TODO啊之类的，我一想其实我也不会，以前都是直接删除掉的，然后找了点资料看看，觉得这几个注释还是很有用的。 特殊注释： 1、 TODO 表示需要实现，但目前还未实现的功能 2 、XXX 勉强可以工作，但是性能差等原因 3 、FIXME 代码是错误的，不能工作，需要修复
代码中 TODO FIXME XXX 注释的特殊含义
SdustLiYang的专栏
10-26 1368
TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: + 说明： 如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简
Java基础：关于Java中的特殊注释？
夏呆毛的博客
02-22 282
不常见的注释 在Java中，文档注释和单、多行注释是最多见到的，下面简单总结一下除了文档注释和单、多行注释之外的注释： TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: + 说明： 如果代码...
Java代码中特殊注释
weixin_38168918的博客
08-21 160
Java代码中特殊注释 TODO: + 说明：标识处有功能代码待编写，待实现的功能在说明中会简略说明。FIXME: + 说明：标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。XXX: + 说明：标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进，要改进的地方会在说明中简略说明。 转载于:https://www.cnblogs.com...
如何在java中正确使用注释
08-25
"如何在Java中正确使用注释" 在 Java 编程中，注释是一种非常重要的组成部分。正确地使用注释可以使代码变得更加易读、易维护和易理解。按照惯例，一份规范的程序源代码中，注释应该占到源代码的 1/3 以上。 Java ...
Java零基础 - Java中的注释.md
08-15
### Java中的注释 在Java编程中，注释是一种非常重要的元素，它们虽然不被编译器执行，但对提高代码的可读性和维护性有着不可忽视的作用。本文将详细介绍Java中的三种注释类型——单行注释、多行注释和文档注释，并...
Java代码注释率检查器.rar
03-16
Javadoc注释是一种特殊的形式，它不仅用于人类阅读，还可以自动生成API文档，因此在某些标准中，Javadoc注释的权重可能更高。 在实际项目中，合理的注释率通常被视为代码质量的一个指标。过低的注释率可能表明代码...
Java的文档注释之生成帮助文档的实例
08-28
在Java编程语言中，文档注释（Javadoc）是一种特殊类型的注释，专门设计用于生成程序的API文档。它能够帮助开发者理解代码的功能、参数、返回值以及作者和版本信息等，极大地提高了代码的可读性和维护性。下面我们将...
java中一种特别的注释-----注解
weixin_42077549的博客
03-20 384
1.注解 1.1 定义 : Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。 Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同，Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注...
巩固java核心基础-特殊注释
weixin_45521583的博客
06-01 120
特殊注释： 1 TODO 表示需要实现，但目前还未实现的功能 2 XXX 勉强可以工作，但是性能差等原因 3 FIXME 代码是错误的，不能工作，需要修复 TODO: + 说明： 如果代码中有该标识，说明在标识处有功能代码待编写，待实现的功能在说明中会简略说明。 FIXME: + 说明： 如果代码中有该标识，说明标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明。 XXX: + 说明： 如果代码中有该标识，说明标识处代码虽然实现了功能，但是实现的方法有待商榷，希望将来能改进
Java 中的注释
qq_43686088的博客
05-10 104
java 注释 用于注解说明解释程序的文字就是注释。 java中的注释类型： 1.单行注释 2.多行注释 3.文档注释（java特有的） -提高了代码的阅读性：调试程序的重要方法。 -注释是一个程序员必须要具有的良好的编程习惯。 -将自己的思想通过注释先整理出来，再用代码去体现 ...
java中的注释讲解
qq_43693115的博客
08-03 264
在编写程序时，为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。 注释是对程序的某一功能或者代码进行解释说明。 Java中的注释有三种类型 1.单行注释 对程序的某一行代码进行解释 int a = 10; //定义一个整型变量 2.多行注释 注释的内容可以为多行 int a; a = 10; /* 我声明一个变量 然后进行初始化 /* 3.文档注释 对一段代码的解释说明，可以通过javadoc命令将文档注释提取出来生成帮助文档 /** 这是一个名为HelloWorld的类 里面还有个Main
Java| Java特殊注释(XXX,TODO,FIXME)解释说明
YvesHe的专栏
10-16 4840
测试代码package cn.com.yves;public class Test { public static void xxx() { // XXX 勉强可以工作，但是性能差等原因. } public static void todo() { // TODO 表示需要实现，但目前还未实现的功能. } public static
Java 代码特殊注释详解
chenshun123的博客
07-12 1180
TODO，FIXME ，XXX  用于标记，方便返回处理操作 TODO : 在标识处有功能代码待编写，待实现的功能在说明中会简略说明 注：点击右边蓝色标记处，回到标记处 FIXME : 标识处代码需要修正，甚至代码是错误的，不能工作，需要修复，如何修正会在说明中简略说明 XXX : 标识处代码虽然实现功能，但是实现的方法有待商榷，希望将来能改进，要改进的
“@”Java中特殊的符号——注解
weixin_43204595的博客
09-28 1118
Java学习记录
eclipse中的特殊注释TODO FIXME XXX
天将降大任于是人
07-08 6719
在eclipse中，TODO、FIXME和XXX都会被eclipse的task视图所收集。在编码过程中，可以使用注释来标记未完成的功能，在提交代码前检查task视图，保证所有功能均完成编码。 此外，在eclipse中，我们可自定义自己的特殊注释标签。进入window—>preferences—>Java—>Compiler—>Task Tags窗口即可添加特殊标签，默认只有TODO、FIXME和
Java中单行注释文档注释多行注释
最新发布
03-21
### Java 中的不同注释类型及其使用方法 #### 单行注释 单行注释用于对代码的一行或多行提供简单的解释或说明。它通过两个连续的斜杠 `//` 开头，直到当前行结束为止[^1]。 这种类型的注释适合于快速描述某一行代码的功能或者临时禁用某些代码。 ```java public class Example { public static void main(String[] args) { int a = 10; // 定义整型变量a并赋初值为10 // System.out.println(a); // 此行为被注释掉的打印语句 } } ``` #### 多行注释 多行注释允许开发者在一个范围内的多行上添加详细的注解信息。它的起始标记是 `/*`，终止标记是 `*/`[^3]。需要注意的是，多行注释内部不能嵌套另一个多行注释[^2]。 ```java public class MultiLineCommentExample { public static void main(String[] args) { /* * 这是一个多行注释的例子。 * 可以跨越多行来详细描述逻辑或其他相关内容。 */ System.out.println("这是一个测试"); } } ``` #### 文档注释 文档注释是一种特殊的注释形式，主要用于生成API文档。其语法是以 `/**` 开始，并以 `*/` 结束[^4]。这类注释通常位于类、接口、字段以及方法定义之前，能够被 JDK 提供的工具 javadoc 解析成 HTML 格式的文档[^5]。 ```java /** * This is the documentation comment. * * @author John Doe * @version 1.0 */ public class DocCommentExample { /** * A method that prints hello world to console. */ public void sayHello() { System.out.println("Hello, World!"); } } ``` 要生成文档，可以运行如下命令： ```bash javadoc -d f:\output_directory -author -version FileName.java ``` 这会将指定 `.java` 文件中的所有文档注释放入到给定路径下的HTML文件中。 --- ### 各种注释的区别总结表 | **特性** | **单行注释 (`//`) ** | **多行注释 (`/* ... */`) ** | **文档注释 (`/** ... */`) ** | |-------------------|----------------------------|----------------------------------|------------------------------| | **适用场景** | 简短说明 | 较复杂的跨多行说明 | 类、方法等结构化说明 | | **是否支持嵌套** | 不涉及 | 不支持 | 支持 | | **功能扩展** | 无 | 无 | 自动生成 API 文档 | ---
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值