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

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

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

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


程序基本概念——注释

 

内容简介

一、       注释的意义

二、       注释的本质

三、       注释的分类

四、       举例

五、       总结

 

 

一、        注释的意义

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

 

二、        注释的本质

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

 

三、        注释的分类

Java中注释共有三类:

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

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

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

 

四、        举例:

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

image.png

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

image.png

五、        总结

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

相关文章
|
3月前
|
存储 自然语言处理 小程序
Python编程入门:从零基础到编写你的第一个程序
【8月更文挑战第31天】探索编码的奥秘,开启你的编程之旅。本文将引导你通过Python语言轻松步入编程世界。无需担心没有基础,我们将从最基础的概念开始,一步步带你理解编程的核心思想,并最终实现一个属于你自己的小程序。让我们一同见证,如何将一行行代码转化为能够执行任务的数字魔法。
|
6月前
|
算法 Unix 程序员
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
【C/C++ 基本知识 注释规范】C/C++中注释方式以及规范
84 0
|
6月前
|
IDE 程序员 开发工具
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
477 0
|
JSON Go 数据格式
Go语言注释和文档生成的最佳实践 就在这里
Go语言注释和文档生成的最佳实践 就在这里
337 0
算法入门几个有用的代码
算法入门几个有用的代码
|
程序员 Linux Go
程序的基本概念|学习笔记
快速学习程序的基本概念
程序的基本概念|学习笔记
|
Java 开发工具 开发者
程序基本概念——注释 | 学习笔记
快速学习程序基本概念——注释
245 0
程序基本概念——注释 | 学习笔记
|
编译器 C# C++
☀️ 学会编程入门必备 C# 最基础知识介绍(六)——接口、命名空间、预处理指令、正则表达式、异常处理、文件的输入与输出
前言👻 接口(interface)🎉 定义接口: MyInterface.cs 接口继承: InterfaceInheritance.cs C# 命名空间(Namespace)🎈 定义命名空间 using 关键字 嵌套命名空间 C# 预处理器指令🎄 C# 预处理器指令列表 #define 预处理器 条件指令 C# 正则表达式🔔 定义正则表达式 C# 异常处理🎃 语法 C# 中的异常类 异常处理 创建用户自定义异常 抛出对象 C# 文件的输入与输出⛄️ C# I/O 类 FileStream 类 C# 高级文件操作
☀️ 学会编程入门必备 C# 最基础知识介绍(六)——接口、命名空间、预处理指令、正则表达式、异常处理、文件的输入与输出
|
Java 编译器 开发者
Java 程序基本概念(注释)|学习笔记
快速学习 Java 程序基本概念(注释)
第二章--第二节:注释
第二章--第二节:注释
114 0