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

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

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

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


程序基本概念——注释

内容简介

一、 注释的意义

二、 注释的本质

三、 注释的分类

四、 举例

五、 总结

一、 注释的意义

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

二、 注释的本质

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

三、 注释的分类

Java中注释共有三类:

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

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

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

四、 举例:

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

image.png

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

image.png

五、 总结

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

相关文章
QT6使用CMamke将qml打包成dll
QT6使用CMamke将qml打包成dll
389 0
|
12月前
|
人工智能 API 开发工具
编码搭子测评
【10月更文挑战第24天】软件开发工程师使用通义灵码个人版,通过`@workspace`快速克隆项目代码库和智能搜索功能,以及AI编码助手自动生成代码框架和优化建议,使新项目上手和新需求实现效率提升约30%,代码质量显著提高。
|
达摩院 供应链 调度
【FlowShop流水线作业排班问题【数学规划的应用(含代码)】阿里达摩院MindOpt】
本文探讨了使用阿里巴巴达摩院的MindOpt工具解决FlowShop流水线作业排班的数学规划问题。FlowShop涉及到多台机器、多个工序和多个作业,目标是通过优化排班最小化总生产耗时。MindOpt通过数学规划方法,如线性或混合整数线性规划,将问题建模并转化为代码,利用云建模平台MindOpt Studio和MindOpt APL建模语言进行求解。案例中详细介绍了参数定义、变量解析、约束设置和目标函数,展示了如何通过MindOpt进行建模和求解,以达到最优化的生产调度。此外,文章还提供了代码示例和结果解析,帮助读者理解如何实际应用MindOpt解决这类问题。
|
存储 Java Linux
linux安装Zookeeper的详细步骤
linux安装Zookeeper的详细步骤
641 5
|
Linux C++
vscode中配置cmake及debug使用
vscode中配置cmake及debug使用
2010 0
|
前端开发
实战:思考如何拆分组件
实战:思考如何拆分组件
173 0
|
Linux
Linux zombie进程详细解析
Linux僵尸进程详细解析 在fork()/execve()过程中,假设子进程结束时父进程仍存在,而父进程fork()之前既没安装SIGCHLD信号处理函数调用 waitpid()等待子进程结束,又没有显式忽略该信号,则子进程成为僵尸进程,无法正常结束,此时即使是root身份kill-9也不能杀死僵尸进 程。
2180 0
|
JavaScript
Vue之mitt事务总线使用方法
Vue之mitt事务总线使用方法
244 0
java类中无法识别依赖包的问题
前段时间因为当前项目比较闲,被换到其他项目组做事情。换项目组带来的问题是,需要下载新的项目,并配置新的开发环境。这次换项目的过程中,有个环节让我花了不少时间折腾,以下就是遇到的问题。
1621 0
|
Kubernetes Cloud Native Serverless
2019 年,容器技术生态会发生些什么?
作者:阿里云智能事业部高级技术专家 张磊 1. Kubernetes 项目被采纳度将持续增长 作为“云原生”(Cloud Native)理念落地的核心,Kubernetes 项目已经成为了构建容器化平台体系的默认选择。
3140 0