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

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

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

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


程序基本概念——注释

 

内容简介

一、       注释的意义

二、       注释的本质

三、       注释的分类

四、       举例

五、       总结

 

 

一、        注释的意义

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

 

二、        注释的本质

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

 

三、        注释的分类

Java中注释共有三类:

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

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

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

 

四、        举例:

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

image.png

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

image.png

五、        总结

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

相关文章
|
自然语言处理 算法 数据挖掘
自蒸馏:一种简单高效的优化方式
背景知识蒸馏(knowledge distillation)指的是将预训练好的教师模型的知识通过蒸馏的方式迁移至学生模型,一般来说,教师模型会比学生模型网络容量更大,模型结构更复杂。对于学生而言,主要增益信息来自于更强的模型产出的带有更多可信信息的soft_label。例如下右图中,两个“2”对应的hard_label都是一样的,即0-9分类中,仅“2”类别对应概率为1.0,而soft_label
自蒸馏:一种简单高效的优化方式
|
5月前
|
存储 安全 Docker
Docker 部署 PicGo:一次配置,随处使用
通过Docker部署PicGo Server版,实现一次配置、随处可用的高效图片管理方案。本文详细介绍了从构建自定义镜像到启动容器的完整流程,涵盖插件安装、图床配置等关键步骤,并特别提醒了安全注意事项。这一部署方式解决了多设备间配置不同步的痛点,让用户在公司、家庭等多场景下都能使用统一的图床服务,真正做到上传记录集中管理、配置云端同步。无论是个人创作者还是团队协作,都能通过Docker化部署获得更灵活、稳定的图片上传体验。
298 8
Docker 部署 PicGo:一次配置,随处使用
|
11月前
|
SQL 运维 数据可视化
需求闭环追踪工具全方位解析:构建从需求到交付的完整追踪链路
在产品开发中,需求管理至关重要。本文探讨了需求闭环管理的核心问题与解决方案,涵盖需求追踪、变更同步、角色分工、反馈机制等内容,并提供实用工具与代码示例,助力团队实现高效协同与持续优化。
|
定位技术 Windows
Windows电脑删除文件时确认是否删除文件的提示对话框的取消显示方法
Windows电脑删除文件时确认是否删除文件的提示对话框的取消显示方法
1048 1
|
NoSQL MongoDB 索引
MongoDB 占用CPU资源过高
MongoDB 占用CPU资源过高
278 0
|
SQL 芯片
数字式秒表电路设计
数字式秒表电路设计
569 1
数字式秒表电路设计
|
存储 前端开发 算法
canvas进阶——实现事件系统
前言 大家好! 我是热爱图形的fly, 之前在群里和粉丝讨论canvas 如何事件系统, 然后呢? 我自己其实也对这个比较感兴趣, 我看过很多canvas 实现的项目, 比如canvas 实现思维导图 「xmind」 , canvas 实现一个「绘图工具」。 然后呢无论是哪一个,其实背后都是在canavs 背后实现了一套事件系统,可惜这些源码都不开源。所以本着学习的激情, 我参考了一些文章实现一个简单事件系统。本篇文章你可以学到下面👇这些内容 我是怎么基于canvas去「构建基础框架」的 几何算法—— 「判断点是不是任意多边形内部」 如何进行「事件分发」和「阻止事件冒泡」 本篇文章我全是干
canvas进阶——实现事件系统
|
SQL XML 安全
半小时了解SQL注入漏洞?(注入方式大全+绕过大全)
🏆今日学习目标: 🍀学习了解sql注入漏洞
924 0
半小时了解SQL注入漏洞?(注入方式大全+绕过大全)
|
资源调度 JavaScript 中间件
【详细教程】教你如何使用Node + Express + Typescript开发一个应用(二)
Express是nodejs开发中普遍使用的一个框架,下面要谈的是如何结合Typescript去使用。
1327 0
【详细教程】教你如何使用Node + Express + Typescript开发一个应用(二)
|
机器学习/深度学习 Ruby
【愚公系列】2022年02月 攻防世界-进阶题-MISC-83(qr-easy)
【愚公系列】2022年02月 攻防世界-进阶题-MISC-83(qr-easy)
841 0
【愚公系列】2022年02月 攻防世界-进阶题-MISC-83(qr-easy)

热门文章

最新文章