JAVA中如何写注释
创始人
2024-03-17 09:00:34
0次
文章目录
- 0 写在前面
- 1 格式
- 2 演示
- 2.1 单行注释
- 2.2 多行注释
- 2.3 生成文档注释
- 3 写在最后
0 写在前面
一段良好的代码应该有注释，这样可以使不同的创作者或者阅读者进行良好的阅读。
与大多数程序设计语言一样，Java 中的注释也不会出现在可执行程序中。因此，可以在源程序中根据需要添加任意多的注释，而不必担心可执行代码会膨胀。
1 格式
在 Java 中，有 3种标记注释的方式。
格式一（单行注释）：// 注释内容
格式二（多行注释）：/* 注释内容 */
格式三（生成文档注释）：/** 注释内容 */
2 演示
2.1 单行注释
最常用的方式：其注释内容从//开始到本行结尾
//双斜线后面加上注释内容
2.2 多行注释
一般用在单行放不开了，需要写在多行时使用。
/*注释内容注释内容注释内容注释内容*/
2.3 生成文档注释
可以用来自动地生成文档，一般用在方法或类上方，进行方法说明或者类说明。
/*** 注释内容* 注释内容* 注释内容* 注释内容*/
3 写在最后
通过注释提高Java 源程序 代码的可读性；使得Java程序条理清晰，易于区分代码行与注释行。 另外通常在程序开头加入作者，时间，版本，要实现的功能等内容注释，方便后来的维护以及程序员的交流。希望所有人都有随手写注释的良好习惯。
但也希望注释精简干练，不然就会又臭又长。
上一篇：SwiftUI AI之如何使用 DALL-E API——生成人脸(教程含源码)
下一篇：【Python自然语言处理】隐马尔可夫模型中维特比（Viterbi）算法解决商务选择问题实战（附源码 超详细必看）
相关内容
热门资讯
前端-session、jwt
目录： （1）session （2&#x...
linux入门---制作进度条
了解缓冲区 我们首先来看看下面的操作： 我们首先创建了一个文件并在这个文件里面添加了...
关于测试，我发现了哪些新大陆
关于测试 平常也只是听说过一些关于测试的术语，但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法
1. 前缀和 假设有一个数组，我们想大量频繁的去访问L到R这个区间的和，...
nodejs：本地安装nvm实...
一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本，node...
JAVA集合知识整理
Java集合知识整理 HashMap相关 HashMap的底层数据结构：jdk1.8之...
无刷直流电机介绍及单片机控制实...
无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2
1.传纸条 AcWing 275. 传纸条 - AcWing 走两条路，走一条最大的...
常用的DOS命令
常用的DOS命令 DOS（Disk Operating System，磁...
＜C++＞ 类和对象(下)
1.const成员函数将const修饰的“成员函数”称之为const成员函数，cons...