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）算法解决商务选择问题实战（附源码 超详细必看）
相关内容
热门资讯
保存时出现了1个错误，导致这篇...
当保存文章时出现错误时，可以通过以下步骤解决问题：查看错误信息：查看错误提示信息可以帮助我们了解具体...
汇川伺服电机位置控制模式参数配...
1. 基本控制参数设置 1）设置位置控制模式 2）绝对值位置线性模...
不能访问光猫的的管理页面
光猫是现代家庭宽带网络的重要组成部分，它可以提供高速稳定的网络连接。但是，有时候我们会遇到不能访问光...
表格中数据未显示
当表格中的数据未显示时，可能是由于以下几个原因导致的：HTML代码问题：检查表格的HTML代码是否正...
本地主机上的图像未显示
问题描述：在本地主机上显示图像时，图像未能正常显示。解决方法：以下是一些可能的解决方法，具体取决于问...
表格列调整大小出现问题
问题描述：表格列调整大小出现问题，无法正常调整列宽。解决方法：检查表格的布局方式是否正确。确保表格使...
不一致的条件格式
要解决不一致的条件格式问题，可以按照以下步骤进行：确定条件格式的规则：首先，需要明确条件格式的规则是...
Android|无法访问或保存...
这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限：此外...
【NI Multisim 14...
目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
银河麒麟V10SP1高级服务器...
银河麒麟高级服务器操作系统简介： 银河麒麟高级服务器操作系统V10是针对企业级关键业务...