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

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

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

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


程序基本概念——注释

内容简介

一、 注释的意义

二、 注释的本质

三、 注释的分类

四、 举例

五、 总结

一、 注释的意义

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

二、 注释的本质

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

三、 注释的分类

Java中注释共有三类:

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

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

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

四、 举例:

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

image.png

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

image.png

五、 总结

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

相关文章
|
8月前
|
算法
‘/’ 和 ‘%’ 在编程中的作用【附加练习题】
‘/’ 和 ‘%’ 在编程中的作用【附加练习题】
|
8月前
|
缓存 Ubuntu 网络协议
Linux系统编程之文件I/O函数的使用:介绍文件I/O函数的基本概念、用法和实现方式
Linux系统编程之文件I/O函数的使用:介绍文件I/O函数的基本概念、用法和实现方式
127 1
|
1月前
|
IDE 程序员 开发工具
Python编程入门:打造你的第一个程序
迈出编程的第一步,就像在未知的海洋中航行。本文是你启航的指南针,带你了解Python这门语言的魅力所在,并手把手教你构建第一个属于自己的程序。从安装环境到编写代码,我们将一步步走过这段旅程。准备好了吗?让我们开始吧!
|
2月前
|
机器学习/深度学习 数据挖掘 开发者
Python编程入门:理解基础语法与编写第一个程序
【10月更文挑战第37天】本文旨在为初学者提供Python编程的初步了解,通过简明的语言和直观的例子,引导读者掌握Python的基础语法,并完成一个简单的程序。我们将从变量、数据类型到控制结构,逐步展开讲解,确保即使是编程新手也能轻松跟上。文章末尾附有完整代码示例,供读者参考和实践。
|
2月前
|
存储 人工智能 数据挖掘
Python编程入门:构建你的第一个程序
【10月更文挑战第22天】编程,这个听起来高深莫测的词汇,实际上就像搭积木一样简单有趣。本文将带你走进Python的世界,用最浅显的语言和实例,让你轻松掌握编写第一个Python程序的方法。无论你是编程新手还是希望了解Python的爱好者,这篇文章都将是你的理想起点。让我们一起开始这段奇妙的编程之旅吧!
40 3
|
5月前
|
存储 自然语言处理 小程序
Python编程入门:从零基础到编写你的第一个程序
【8月更文挑战第31天】探索编码的奥秘,开启你的编程之旅。本文将引导你通过Python语言轻松步入编程世界。无需担心没有基础,我们将从最基础的概念开始,一步步带你理解编程的核心思想,并最终实现一个属于你自己的小程序。让我们一同见证,如何将一行行代码转化为能够执行任务的数字魔法。
|
6月前
ES6 扩展运算符 ...【详解】(含使用场景、实战技巧和范例、实现原理、错误用法)
ES6 扩展运算符 ...【详解】(含使用场景、实战技巧和范例、实现原理、错误用法)
64 5
|
8月前
|
缓存 监控 Java
Hysterix的概念、作用、使用方法
Hysterix的概念、作用、使用方法
75 0
|
8月前
|
IDE 程序员 开发工具
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
Python 进阶指南(编程轻松进阶):十一、注释、文档字符串和类型提示
488 0
|
小程序 JavaScript
讲述小程序之其他常用内容
讲述小程序之其他常用内容
113 0
讲述小程序之其他常用内容