锐客网

  1. 首页 > 睿知 > it技术 > >

java中代码注释的方式 java编程注释

注释IT技术

为什么要为程序添加注释，在java程序中如何为程序添加注释？注释是用来给开发者或者是软件后续的维护者来看的 。一般是用来描述这一段代码或者是程序做了些什么样的事情 。实现了哪些功能，java里面注释代码 ， 可以分为行注释和块注释 ， 方法注释等 。
行注释就是在需要注释的代码前加 //
块注释则是用 /*和*/把文本段落框起来即可
java中的注释可分为三种类型Java中三种类型的注释：
单行注释：// 注释内容
多行注释：/*... 注释内容....*/
文本注释：/**.. 注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率 。也是程序代码可维护性的重要环节之一 。所以不是为写注释而写注释 。
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外 ， 持久化对象或VO对象的getter、setter方法不需加注释 。
扩展资料：
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等 。
参考资料来源：百度百科-java注释
java中的三种注释第一种
//单行注释
使用方法举例
int a =10
// int b=3.14这句没有用，被注释掉了
第二种
/*
多行注释
*/
放在 /*
*/之间的代码全部会被注释
string name；
int age；
string address；
string tel;
/* private Button button1;
private Button button1;
private Button button1;
*/
上面代码所有的Button定义被注释掉了 。
第三种：JavaDOC文档注释,对代码中的内容及一些内容进行描述
比如一些版本，作者信息
/**
* 文档注释
* version1.0
* Date: 2020.10.02
* author nandasl
*/
如何用Eclipse快速注释程序代码？在进行程序调试时，可能需要注释掉大片的程序代码，以缩小Bug出现的范围，从而尽快锁定错误原因 。那么使用Eclipse如何快速注释程序代码呢？下面就讲解3种常用方法 。
法一：使用Ctrl /快捷键
第1步：在Eclipse中拖动鼠标，选中需要注释的代码，通常为连续多行代码 。
第2步：按住Ctrl /快捷键
第3步：会发现所选代码被“//”注释掉 。当调试完后，可再次按住Ctrl /快捷键打开注释 。
方法二：使用Ctrl Shift C快捷键
第1步：在Eclipse中拖动鼠标，选中需要注释的代码 。
【java中代码注释的方式 java编程注释】第2步：按住Ctrl Shift C快捷键
第3步：会发现所选代码被“//”注释掉 。当调试完后，可再次按住Ctrl Shift C快捷键打开注释 。
方法三：使用Ctrl Shift /快捷键
第1步：在Eclipse中拖动鼠标，选中需要注释的代码 。
第2步：按住Ctrl Shift /快捷键 。
第3步：会发现所选代码被“/**/”注释掉 。
第4步：当调试完后，可按住Ctrl Shift \快捷键打开注释 。
Java如何进行单行注释和多行注释？（1）单行注释：以“ //”开头后面接所要加的说明的内容 。如下面所示：//定义变量aint a = 10;//定义变量bint b = 20;上面的语句中，在编译的过程就会直接略过注释，只会编译 int a = 10 和 int b = 20这两句 。由此可见注释只是起着说明的作用 。
（2）多行注释：以“/*”开头，以“*/”结尾 。假设当你要说明你所写的代码的功能时 。要说明的内容有很多 。如果全部放在同一行会显得很难看 。所以一般会用多行来写 ， 如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明 。但如果有10行说明就要按十个“//”这显示很麻烦，所以这时就可采用多行注释 。上面的可改成：/*说明说明说明说明*/也可以这样/* 说明说明说明说明 */
（3）文档注释：以“/**”开头，以“*/”结尾 。文档注释主要是生成文档的 。
关于java中代码注释的方式和java编程注释的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息 ， 记得收藏关注本站 。

    推荐阅读


    上一篇：安装net出现错误代码，2016安装net出错

    下一篇：如何使用ISL服务器？ isl服务器怎么用