程序基本概念——注释 | 学习笔记

简介: 快速学习程序基本概念——注释

开发者学堂课程【Java编程入门程序基本概念——注释】学习笔记,与课程紧密联系,让用户快速学习知识。

课程地址https://developer.aliyun.com/learning/course/18


程序基本概念——注释

 

内容简介

一、       注释的意义

二、       注释的本质

三、       注释的分类

四、       举例

五、       总结

 

 

一、        注释的意义

注释是程序开发中的一项重要组成技术。合理的注释可以使项目维护更加方便,但是很多公司由于技术管理问题,注释不尽合理,使得项目维护非常不便,在人员更换时期非常痛苦,对后续工作造成了很大的困扰。特别是新人在项目维护的时候,发现只有若干行代码,没有一个注释,给新人带来了巨大的工作压力。所以注释是一个非常重要的概念。

 

二、        注释的本质

注释的本质在于,编辑器在进行程序编译的时候,如果发现有注释的内容,将不对此部分进行编译处理。即用来解释说明的文字分类。

 

三、        注释的分类

Java中注释共有三类:

1)     单行注释://,即双斜线之后到当前行结尾的内容被注释。

2)     多行注释:/*  ……*/,则/* */之间的内容被注释掉,可以跨多行注释。

3)     文档注释:/** …*/;(文档注释需要很多选项,一般建议通过开发工具控制,因为采取手写的方式较为麻烦。)

 

四、        举例:

定义单行注释:新建程序后,输入单行注释标志符号,添加所要注释的内容。

image.png

定义多行注释:可在单行注释标志符号处删改,使用多行注释标志符号,添加所要注释的内容。

image.png

五、        总结

使用什么类型的注释,依据个人实际情况来决定;如果使用开发工具开发,单行注释较为方便;对于一些重要的类或者方法,建议使用文档注释。

目录
打赏
0
0
0
0
50
分享
相关文章
1024,致开发者们——希望和你一起用技术人独有的方式,庆祝你的主场
阿里云开发者社区推出“1024·云上见”程序员节专题活动,包括云上实操、开发者测评和征文三个分会场,提供14个实操活动、3个解决方案、3 个产品方案的测评及征文比赛,旨在帮助开发者提升技能、分享经验,共筑技术梦想。
1690 160
IDEA使用Spring Initializr流畅的创建springboot项目
IDEA使用Spring Initializr流畅的创建springboot项目
723 0
DataWorks不是Excel,它是一个数据集成和数据管理平台
【10月更文挑战第10天】随着大数据技术的发展,企业对数据处理的需求日益增长。阿里云推出的DataWorks是一款强大的数据集成和管理平台,提供从数据采集、清洗、加工到应用的一站式解决方案。本文通过电商平台案例,详细介绍了DataWorks的核心功能和优势,展示了如何高效处理大规模数据,帮助企业挖掘数据价值。
291 1
使用Python实现深度学习模型:智能饮食建议与营养分析
使用Python实现深度学习模型:智能饮食建议与营养分析
727 3
Jenkins 在持续集成/持续交付(CI/CD)管道中的应用
【8月更文第31天】 在现代软件开发过程中,持续集成(Continuous Integration, CI)和持续交付(Continuous Delivery, CD)已经成为提升开发效率和软件质量的重要实践。Jenkins 是一个广泛使用的开源工具,它能够帮助团队实现自动化构建、测试和部署,是 CI/CD 流水线的核心组件之一。本文将详细介绍 Jenkins 在 CI/CD 管道中的应用,并提供具体的代码示例。
417 0
使用Python实现深度学习模型:模型部署与生产环境应用
【7月更文挑战第7天】 使用Python实现深度学习模型:模型部署与生产环境应用
428 0
利用Java实现随机采样
利用Java实现随机采样
408 0
k8s教程(service篇)-概念和原理(上)
k8s教程(service篇)-概念和原理(上)
323 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等