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

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

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

       我学习使用的是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 

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

 

 

 

 

    原文作者:软嘴唇0220
    原文地址: https://blog.csdn.net/m0_51259350/article/details/122827001
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞