零基础开始学习Java,我们应该如何入手呢?本文将分享以下的6点以帮助朋友们更好的学习。
1、Java注释:
- 注释是什么,我们为什么要学习注释?
- 注释的分类?
- 注释使用的注意事项?
注释前后对比
注释概念:
注释就是对程序添加的说明信息,简单的理解就是对代码的解释说明
通过注释提高Java源程序代码的可读性;使得Java程序条理清晰,易于区分代码行与注释行。另外通常在程序开头加入作者,时间,版本,要实现的功能等内容注释,方便后来的维护以及程序员的交流。
Java注释的分类:
- 单行注释:格式://注释信息
- 多行注释:格式:/*注释信息*/ (从/*到*/结束,可以注释一行或多行。多行注释的时候,不能嵌套使用,否则会报错。)
- 文档注释:格式:/**注释信息*/(以/**开始,以*/结束,可以注释单行,也可以注释多行。在Java中,文档注释也被用于生成API文档)
1、程序中的注释,用来说明某段代码的作用,或者说明某个类的用途、某个属性的含义、某个方法的功能,方法参数和返回值的数据类型、意义等。 2、注释可以增强代码的可读性,让自己或者他人快速的理解代码含义和设计思路,同时可以便于后期的对系统中代码的维护和迭代升级等。 3、Java源码代码中的注释,不会出现在字节码文件中,因为在编译的时候,编译器会忽略掉源代码中的注释部分。因此,可以在源代码中根据需要添加任意多的注释,而不必担心字节码文件会膨胀。 4、源代码中,被注释掉的部分(代码、文字等),不会对代码的编译、运行产生任何影响。
文档注释:Javadoc(文档注释)详解
Java支持3种注释,分别是单行注释、多行注释和文档注释。文档注释以/**开头,并以*/结束,可以通过 Javadoc 生成 API 帮助文档,Java 帮助文档主要用来说明类、成员变量和方法的功能。
文档注释只放在类、接口、成员变量、方法之前,因为 Javadoc 只处理这些地方的文档注释,而忽略其它地方的文档注释。
Javadoc 是 Sun 公司提供的一种工具,它可以从程序源代码中抽取类、方法、成员等注释,然后形成一个和源代码配套的 API 帮助文档。也就是说,只要在编写程序时以一套特定的标签注释,在程序编写完成后,通过 Javadoc 就形成了程序的 API 帮助文档。
API 帮助文档相当于产品说明书,而说明书只需要介绍那些供用户使用的部分,所以 Javadoc 默认只提取 public、protected 修饰的部分。如果要提取 private 修饰的部分,需要使用 -private。
Javadoc标签
注释就是对程序添加的说明信息,简单的理解就是对代码的解释说明一般以@开头,后跟一个指定的名字,有的也以{@开头,以}结束。Javadoc 可以识别的标签如下表所示:
标签 | 描述 | 示例 |
---|