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）算法解决商务选择问题实战（附源码 超详细必看）
相关内容
热门资讯
AWSECS：访问外部网络时出...
如果您在AWS ECS中部署了应用程序，并且该应用程序需要访问外部网络，但是无法正常访问，可能是因为...
AWSElasticBeans...
在Dockerfile中手动配置nginx反向代理。例如，在Dockerfile中添加以下代码：FR...
银河麒麟V10SP1高级服务器...
银河麒麟高级服务器操作系统简介： 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
北信源内网安全管理卸载
北信源内网安全管理是一款网络安全管理软件，主要用于保护内网安全。在日常使用过程中，卸载该软件是一种常...
AWR报告解读
WORKLOAD REPOSITORY PDB report (PDB snapshots) AW...
AWS管理控制台菜单和权限
要在AWS管理控制台中创建菜单和权限，您可以使用AWS Identity and Access Ma...
ToDesk 远程工具安装及...
目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
群晖外网访问终极解决方法：IP...
写在前面的话 受够了群晖的quickconnet的小水管了，急需一个新的解决方法&#x...
不能访问光猫的的管理页面
光猫是现代家庭宽带网络的重要组成部分，它可以提供高速稳定的网络连接。但是，有时候我们会遇到不能访问光...
Azure构建流程（Power...
这可能是由于配置错误导致的问题。请检查构建流程任务中的“发布构建制品”步骤，确保正确配置了“Arti...