当前位置: 首页 > article >正文

java入门 - 规范你的代码注释

java基础语法-代码注释

注释只是为了提高可读性,不会被计算机编译。代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。

开发中注释可以分为三种方式:

  • 行注释
  • 块注释
  • 类/方法注释。

行注释

行注释是对一行代码进行注释,ide工具(idea/eclipse)可以使用ctrl+/ 快捷键进行快速对选中的行注释。最常见的使用场景是在方法内注释某个属性或某块区域的含义。

image-20240318160616822

块注释

块注释是对多行注释的一种方式。一般用在多行内容进行注释说明。

image-20240318161021741

类方法注释

此类注释一般用在的说明,方法说明上。注意与块注释不同第一行有两个*号。

image-20240318161259482

很多公司还对公司开发中的注释给出了严格的规范,大家进入公司后先看看之前同事的代码,学习他们的注释规范。这样能够快速融入团队。


http://www.kler.cn/a/272879.html

相关文章:

  • Golang学习笔记_26——通道
  • DNS介绍与部署-Day 01
  • Docker PG流复制搭建实操
  • FFmpeg硬件解码
  • 港科夜闻 | 香港科大与微软亚洲研究院签署战略合作备忘录,推动医学健康教育及科研协作...
  • systemverilog中type typedef的区别
  • SSH介绍及检测规则思路分析
  • 2024年Microsoft Office计算机二级考试必考45题
  • 19 # 高级类型:索引类型
  • Django生命周期
  • Python的接口自动化unittest测试框架和ddt数据驱动
  • 12 Python多进程
  • 前端基础篇-快速了解 Vue 前端框架(Vue 指令)
  • 提高效率,就信赖快速开发表单平台
  • 如何跨数据源根据一张表字段更新另一张表字段数据
  • IOS面试题object-c 91-100
  • 上传照片怎么改大小?几个图片改大小的方法
  • Codeforces Round 918 (Div. 4)----->E. Romantic Glasses
  • 计算机组成原理-2-计算机的发展应用
  • openEuler-22.03-LTS-SP2更改阿里云yum安装源
  • python异常:pythonIOError异常python打开文件异常
  • 阿里云云服务器ECS端口多个端口号开通教程
  • 组建对等网
  • Qt Excel文件读写
  • 深入理解Linux内核页表映射分页机制原理
  • 软考怎么考?高项科目这么多,应该怎么选?