关于java开发中一些注释和标识符的问题
注释问题
java语言中的注释一般分为三种,单行注释,多行注释,文档注释。单行注释
单行注释
以idea(集成开发环境IDEA)为例,在开发过程中的单行注释,样式为"//注释内容"。
示例如图:
java语言在单行注释的格式这一方面,和c语言是相同的,c语言中单行注释的格式也是"//注释内容"。
多行注释
同样的,在java中,多行注释的格式与c语言也是相同的,其格式为"/*注释内容*/"
示例如图:
文档注释
在java语言中,还有一种注释,叫做文档注释,即为JavaDoc生成文档。在普通的日常开发中用到的不多,它不同于单行和多行注释,这个注释的信息可以用开发的描述。其语法格式为"/**注释内容*/"
示例如图:
如上图所示,此处可以看到,这个注释每一行都有星号,且可以生成所定义的开发描述。
再如下图:
当你定义一个属性,并创建一个类的时候,使用文档注释,在idea中,当你打出"/**"时,自动显示了一些该类的信息,显示这是一个构造函数,参数为name,还有异常抛出。这些生成的参数信息是关于文档注释的重要内容。
在现代开发中,企业级的开发会要求代码的规范书写,同时可能也会要求使用文档注释,以描述开发过程中的一些参数信息。
该注释表面上看起来和多行注释没有不同,更有甚者可能会把它当做注解来看,但是这是不同的两个概念,例如,当我在这个Hello.java所在的文件夹下打开命令行,以命令行的方式来运行这个文件。如图:
-encoding和-charset都是为了统一字符编码,使其识别中文注释,如图,并无任何特殊情况出现,但是在该文件夹下,生成了一些文档,如图所示:
我们打开其中的index.html,在这里是首页的意思,打开首页我们可以看到,这个命令生成了一份类似于javaAPI文档的内容。如图:
由此可见,该命令的作用是生成一个Doc文档,它的作用在于描述这个.java文件的一些开发信息,如图中提示的方法,静态方法,构造概要等信息。
在面向企业级开发的过程中,可能会要求你使用这些东西来标明你的开发工作以及开发描述。
而在idea中,你需要通过点击Tools,选择Generate JavaDoc,会弹出如图界面:
在Scope中选定你需要生成doc的范围,在如下的设置中你需要配置生成路径以及需要生成的参数。
总之,该方法的使用有助于你理解和掌握开发文件的一些参数信息以及重要的方法和构造等等。
标识符
在java中,类名,变量名,方法名都被称之为标识符。
-
而在java中,关于标识符的要求,其应该使用大小写字母,$,或者下划线_开始,不能有其他方式开头。
-
而在上述的符号开头之后,你可以使用包括大小写字母,$,下划线_或者数字的组合。
-
标识符是大小写敏感的。java是强类型的语言,大小写是两个不同的概念。
在java开发中,存在一些关键词,这些关键词有些是数据类型,有些用作类定义,而这些关键字是不能用作变量名或者方法名的,其如下所示:
这里面有很多熟悉的关键词,例如在书写一个java语言的hello输出程序时,我们就用到了public,class,static,void等几个关键字。
在java中,是可以使用中文来定义类名和变量名,但一般不作使用,这样的命名不符合代码书写规范,而且如果你的代码要被他人查看使用,这样的使用大概不会被他人所认可。
学习浅谈
-
在java中,对于注释的应用是非常多的,因为现在的开发一般要求代码编写规范,书写注释不仅是为了能更方便的阅读代码,也是为了在团队合作中,别人能够快速的理解你的代码。
-
关于JavaDoc的使用,一般面向企业级开发的过程中,为了大大的提高开发效率可能会要求你这样做。
-
标识符的问题,是java开发中要求较为严格的部分,java的书写规范要求你熟练掌握这些标识符和关键字,不建议死记硬背,在后续日常开发中会使用这些关键字,潜移默化之下就可以熟练掌握。