关于代码的注释的几种方法

article/2025/10/27 0:23:16

       注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。注释只是为了提高可读性,不会被计算机编译。

       注释一般分为行注释和块注释,行注释是在某一个注释符号之后的内容不被计算机运行,块注释是在某两个注释符内的内容不被计算机运行。

       我学习使用的是C#,使用的软件是VS2019,常见的行注释我们会用到注释符"//",在某一行需要注释的内容前打上”//“符号,则在符号后的内容将会变为绿色,并且不被运行。如图1所示,加入注释符的一段文字显示绿色,并且不被计算机运行,运行时只会显示一段“Hello World”。

图1

       块注释时,我们将在需要注释的内容前与内容后分别插入符号"/*","*/",这样整段代码将会变成绿色,并且不被计算机所执行。如图2所示。

图2

       针对以上的注释方式还有快捷键去使用,如果我们想要把一段代码进行注释时,可以用鼠标选中这一段,按ctrl+K+C,整段变成注释,如需要恢复则把选中段按ctrl+K+U。如图3所示。

图3

       如果我们在方法和函数前对函数进行说明解释型的注释,在段落上一行按三次"/",则会出现一种专门对下文解释的格式。如图4所示。

图4 

        通常在面对繁杂的代码时,我们还会经常性选择用一种分块预处理的整理方式 ,可以在使用VS代码编辑器的大纲显示功能时指定可展开或折叠的代码块。首先选中需要折叠的代码块,按ctrl+K+S后并选择"#region,此时这一段代码的左边会有一个"+",点击就可以达到折叠的目的,#region后可以用文字进行解释说明。如图5所示

图5 

       对于初学者的我,这因该就是比较常见的注释操作方法,以后可能会遇见更多的方式方法。对于刚开始接触代码的我,这是我的第一篇文章,主要为了记录一下自己学习的过程,顺便也能巩固一下自己的知识。

 

 

 

 


http://chatgpt.dhexx.cn/article/vfdkyPg2.shtml

相关文章

C++设计模式之观察者模式和发布订阅模式

在软件工程中,设计模式(Design Pattern)是对软件设计普遍存在(反复出现)的各种问题,锁提出的解决防范。根据模式的目的来划分的话,GoF(Gang of Four) 设计模式可以分为以…

Redis发布订阅模式实现原理

前言 发布订阅系统在我们日常的工作中经常会使用到,这种场景大部分情况我们都是使用消息队列,常用的消息队列有 Kafka,RocketMQ,RabbitMQ,每一种消息队列都有其特性,很多时候我们可能不需要独立部署相应的消…

RabbitMQ入门案例之发布订阅模式

前言 本文章主要介绍RabbitMQ的发布订阅模式,该模式下,消息为广播形式,一经发布则会进入交换机绑定的队列中,详细介绍可以阅读官方文档。 官网文档地址:https://rabbitmq.com/getstarted.html 什么是发布与订阅模式 …

浅谈JS发布订阅模式

🏆分享博主自用牛客网🏆:一个非常全面的面试刷题求职网站,真的超级好用🍬 文章目录 前言一、发布订阅模式是什么?二、使用步骤1.创建调度中心2.实际操作3. React中的应用 总结 前言 在使用前端各大框架时&…

React 中的发布订阅模式

1、react 通信 react的数据流是单向的, react 通信有以下几种方式: 单向数据流:指当前组件的 state 以 props 的形式流动时只能流向组件树中比自己层级更低的组件 父向子通信:父组件提供state,并且内部设置好数据,子组…

深入Vue原理_全面剖析发布订阅模式

文章目录 发布订阅模式优化优化思路思考理解发布订阅模式(自定义事件)收集更新函数触发更新函数6.5 总结 总结写在最后本期推荐 欢迎各位小伙伴们! 为大家推荐一款刷题神奇哦 点击链接访问牛客网 各大互联网大厂面试真题。从基础到入阶乃至原理刨析类面试题 应有尽有…

观察者模式VS发布订阅模式区别

观察者模式VS发布订阅模式区别 观察者模式:订阅者收集函数,发布者循环调用 发布订阅:收集发布单独给一个中介 对比 以结构来分辨模式,发布订阅模式相比观察者模式多了一个调度中心; 以意图来分辨模式,都…

RabbitMQ:发布订阅模式

✨ RabbitMQ:发布订阅模式 1.订阅模式基本介绍2.交换机3.发布订阅模式3.1基本介绍3.2生产者3.3消费者3.4测试 📃个人主页:不断前进的皮卡丘 🌞博客描述:梦想也许遥不可及,但重要的是追梦的过程,用博客记录自己的成长,记…

JavaScript设计模式:四、发布订阅模式

JavaScript设计模式:四、发布订阅模式 文章目录 JavaScript设计模式:四、发布订阅模式一、概述1. 观察者模式2. 发布订阅模式3. 观察者模式是不是发布订阅模式 一、概述 观察者模式: 观察者(Observer)直接订阅&#x…

发布订阅模式理解

发布订阅模式理解 1.发布-订阅模式 发布订阅模式是一种一对多的对象对应关系,多个观察者同时监听某一个对象,当该对象发生改变时,就会执行一个发布事件,这个发布事件会通知所有的事件订阅者,事件订阅者根据得到的数据…

JS观察者模式和发布订阅模式

观察者模式 观察者模式在前端工程中是很常见的设计模式,因为前端交互中充斥着大量多控件联动的交互,当参与联动的组件数量比较多或者组件数量可能变化的时候,代码就会变得难以维护。但是如果我们写代码时遵循了观察者模式的设计,…

redis发布订阅模式详解

文章目录 写在前面发布订阅的使用SUBSCRIBE命令PUBLISH命令注意发布、订阅客户端启动顺序! PUBSUB命令PUNSUBSCRIBE命令UNSUBSCRIBE命令PSUBSCRIBE命令 总结 写在前面 Redis 发布订阅 (pub/sub) 是一种消息通信模式:发送者 (pub) 发送消息,订…

Vue发布订阅模式

简单的来说一下在别人问你这个问题的时候怎么来回答它 前端新人,如有错误求大佬指出~求教💝 情景复现 大佬提问:“你知道Vue发布订阅模式是什么吗?" 我的回答:“发布订阅模式其实是一种对象间一对多的依赖关系&…

观察者模式和发布订阅模式

一、概念 观察者(Observer),又称发布-订阅(Publish-Subscrice),属于23中设计模式之一。 发布订阅模式定义了一种一对多的依赖关系,让多个订阅者对象同时监听某一个主题对象。这个主题对象在自身状态变化时&#xff0c…

C++发布订阅模式

C发布订阅模式 发布订阅模式主要包含三个部分:消息发布、消息订阅者、消息处理中心。与观察者模式相比多出了消息处理中心模块,这样在结构上可以解耦订阅者与发布者,功能上更加的丰富。 观察者模式 结构设计 有一个消息list,主…

Java实现发布订阅模式

什么是发布订阅模式 发布订阅模式是软件开发者很常见的一种设计模式,很多开源库都使用了发布订阅模式,例如RxJava、EventBus、Vue等,所以学习该模式还是很有必要的。 该模式中存在一个或多个发布者,一个或多个订阅者&#xff0c…

设计模式 —— 发布订阅模式

设计模式 —— 发布订阅模式 《工欲善其事,必先利其器》 我在之前有写过一篇关于 《观察者模式》 的文章,大家有兴趣的可以去看看,个人认为那个例子还是挺生动的。(狗头) 不过今天我们要学习的是,发布订阅…

小侃设计模式(十八)-发布订阅模式

1.概述 发布订阅模式又叫观察者模式(Observer Pattern),它是指对象之间一对多的依赖关系,每当那个特定对象改变状态时,所有依赖于它的对象都会得到通知并被自动更新,它是行为型模式的一种。观察者模式内部…

发布-订阅模式

发布-订阅模式 学习知识要善于思考,思考,再思考。 —— 爱因斯在众多设计模式中,可能最常见、最有名的就是发布 - 订阅模式了,本篇我们一起来学习这个模式。 发布 - 订阅模式 (Publish-Subscribe Pattern, pub-sub&a…

什么是发布订阅模式?

发布-订阅模式(Publish-Subscribe pattern)是一种软件架构模式,用于实现组件之间的解耦和消息传递。在这种模式中,组件(发布者)将消息发送到一个中心(消息代理或主题),然…