博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
javaSE基础知识 1.1代码注释
阅读量:7094 次
发布时间:2019-06-28

本文共 1279 字,大约阅读时间需要 4 分钟。

本人第一次写博客 希望大牛多多关照 如果有不对的地方请大牛指出  

本文章将会持续更新直到SE基础结束为止

前面JDK安装和Eclipse安装请百度查找进行下载,这里JDK推荐1.8版本,1.8版本是一个已经完善的版本,安全性较高,1.8之后的版本也是基于1.8版本进行再次开发和拓展。

这个是JDK1.8的下载地址

https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

这个是Eclipse的下载地址

https://www.eclipse.org/downloads/

代码的注释与编码规范

下面我们来讲一下代码的注释与编码的规范因为合理的注释和编码规范可以为之后团队等个人开发和维护时提供很好的方便
通过在代码中添加注释可以提高代码的阅读性可以帮助程序员更好的阅读代码 其中代码是让计算机识别的 例如下面这段代码

上面这段代码就是给计算机阅读的,计算机会将我们写的代码转化成计算机可以识别的字节码,就向这样1010的字节码

其实呢,我们写的代码是给程序员看的,所以呢程序员写的代码不仅要计算机能读你的程序,也需要其他程序员能读懂你的程序,如果你开发时看到的是这样的代码,或者你让其他人看你写的这段代码,不管哪个人是否是初学者或者工作很多年,当他看到这段代码的第一感觉肯定会疯掉的

但是如果我们给这段代码加上注释再给别人看的话,这时就一目了然了,这些代码的每一行作用以及后期维护都带来方便

有的初学者就会感觉,我自己写的代码我自己看懂就行了,其实这是一个致命的错误,如果你写的代码不加注释过了1个月,2个月,再让你看这些代码时你肯定会说当时自己写的是什么鬼,在公司开发过程中,开发人员和维护人员是分工协作的,当你写的代码乱糟糟的后期维护人员,维护时肯定会疯掉的,所以注释是必不可少的

注释是个好东西

注释就是对代码的解释和说明,对每一处重要的代码都要加一处注释,其中有的人会担心自己的代码有注释会不会运行,放心,注释范围内的任何东西都不会被计算机进行编译执行

注释的三个种类

// 这种叫做单行注释,这两个//之后的东西都不会被计算机进行编译执行复制代码

/*   这种叫做多行注释,在两个/*之间的内容都不会被计算机进行编译执行*/复制代码

/*** 这种叫做文档注释,文档注释一般对类中的方法和类进行文档注释,它也是一种多行的注释*/复制代码

这三种注释中,我们最常用的呢就是前两种注释,单行注释和多行注释,这两种注释呢是帮助我们调试程序,添加解释说明的,第三种文档注释是帮助我们生成帮助文档的

下面我们来看看这三种注释,

这里用了单行注释就只输出了5行 下面来看看多行注释

这里只输出了3行 下面来看看文档注释

这里呢,这个注释是对这个类进行注释说明,当实例化调用这个类时就会提示所说明的作用,方法上面的文档注释是对方法进行注释说明

转载于:https://juejin.im/post/5c5419606fb9a049e93d2aa1

你可能感兴趣的文章
GDI+ 学习记录(2): 画笔线帽 - Cap
查看>>
一张表里的多个字段值 取自 字典表里的text 的查询
查看>>
golang tcp socket
查看>>
特么的程序员励志故事(小IT职员在北京5年买了500W的房子)
查看>>
全选和反选 checkbox
查看>>
wget
查看>>
Linux设置用户登录提示
查看>>
js metro仿win8卡片效果
查看>>
Samba服务器的配置 , nfs配置解析
查看>>
我的友情链接
查看>>
document.body属性
查看>>
c++ 广义表
查看>>
esxi中虚拟机中GTX1070
查看>>
docker
查看>>
vc char * 转换为 LPCTSTR的方法
查看>>
Spring(一)——总体介绍
查看>>
select count(*)和select count(1)的区别
查看>>
Spring AOP实现对redis统一管理 (注解方式)
查看>>
在XenServer 6.0中设置自动启动虚拟机
查看>>
文件管理命令及变量基础
查看>>