为什么要为程序添加注释,在java程序中如何为程序添加注释?

为什么要为程序添加注释,在java程序中如何为程序添加注释?,第1张

注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪闭乎些功能,神拿java里面注释代码,可以分为行注释和块注释,方法注释等。

行轿瞎悉注释就是在需要注释的代码前加 //

块注释则是用 /* 和 */ 把文本段落框起来即可

1)什么是注释?

注释是在编写代码时,用于对代码进行手动文字描述的一种方式。注释还有一个用处是把暂时不需要的代码进行处理,标记为注释的文字不会被编辑器识别报错,即便是语法错误的代码只要标记注释也没有任何问题。重要:谨记“不写注释是流氓,名字瞎起是扯淡”

2)为什么使用注释?

有时候编写的代码太多太复杂时,需要对一句或者一段代码进行文字描述,用于记录代码的功能以方便以后的观察。但严格地说,编写代码时并不是注释越多越好,而是在适当的时候,适当的地方使用注释,如果是很简单的代码则不需要增加注释。

在编写一个程序时,就会写很多代码。如果不小心多按了一下键盘,就会留下一个很致命的字符。我们编写代码的环境必须要求写的代码符合编写规则。如果随意使用中文下的字符或者不注意大小写,甚至认为不小心在某个位置多写了一个字符就觉得无所谓,那么就是大错特错。

上面图片演示的错误就是随意在代码编写时输入中文,VS(就是你写代码用的这个工具简称) 就会检测出这些错误并报红线提示,告诉你这里可能存在错误。所以这时候注释的好处就体现出来了。如果要在代码后面描述一下这句代码有什么作用,避免自己以后在看到代码而一时想不起这句代码的作用,就可以这么做:

3)如何使用注释?

注释分为三种:

================================

1.单行注释 //

2.多行注释 /*要注释的内容*/

3.文档注释 ///(多用来解释类或者方法)

================================

单行注释上面演示过了,就是在双斜杠后面可以写上一句自己对这句代码要做的描述或补充。现在来演示一下多行注释:

多行注释需要在要注释的第一行代码头加上/*,在要注释的最后一行兄山代码尾部加上*/。通常用于注释多行代码,这样只需要两个符号,就可以让这段代码不被程序执行。换句话说就是:变绿色的代码失去了执行的意义 。

文档注释是在方法名上写出三个斜杠,这样会自动补全文档注释格式,只做一烂逗次演示,现在不详细讲:

红色箭头指示的就是给Main方法做的文档注释。强调一次:注释的东西不会影响到程序的正常执行,注释只是程序员对自己代码做功能描述或补充,方便以后看懂代码或修改代码。

4)补充

最后补充在VS中常用的三个快捷键:

1.快速对齐代码 ctrl+K接饥尘卖着ctrl+D。在VS里编写代码有个好处是代码有时候会自动补全和对齐,但如果有时候感觉代码变乱了,可以尝试使用这个。

2.注释所选代码 ctrl+K接着ctrl+C。先选中需要注释的代码,一行或者多行,然后使用这个快捷键。相当于在选中的每行代码前自动添加//。

3.取消注释代码 ctrl+K接着ctrl+U。如果有批量被注释的代码,用此快捷键相当于去掉选中的每行代码前的一对//。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/12552573.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-26
下一篇 2023-05-26

发表评论

登录后才能评论

评论列表(0条)

保存