java代码方法注释,Java代码注释-成都创新互联网站建设

关于创新互联

多方位宣传企业产品与服务 突出企业形象

公司简介 公司的服务 荣誉资质 新闻动态 联系我们

java代码方法注释,Java代码注释

什么是注释?如何在Java程序中加入注释?

试想一下,一个没有一句注释的程序源码,怎么读,一个程序要上万条代码不可能全部记得住哪一块是什么用,而且一个项目也不会是一个人独自完成,那样效率太低,多人合作就要给别人说明,每一块是什么用,方便他人使用,方便自己更正,而这些说明文字就是注释,注释不会被执行,不影响运行结果。

阿鲁科尔沁网站建设公司创新互联建站,阿鲁科尔沁网站设计制作,有大型网站制作公司丰富经验。已为阿鲁科尔沁上千多家提供企业网站建设服务。企业网站搭建\成都外贸网站建设要多少钱,请找那个售后服务好的阿鲁科尔沁做网站的公司定做!

Java中代码的注释有三种:

// 注释一行 

/* ...... */ 注释若干行 

/** ...... */ 注释若干行,并写入 javadoc 文档

前两种比较容易理解,至于第三种,你学习Java看的api文档就是javadoc程序根据第三种的注释生成的。

扩展资料

注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。

java方法名前注释问题

Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。

注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。

1.1、@Retention: 定义注解的保留策略

@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中,在class字节码文件中不包含

@Retention(RetentionPolicy.CLASS) // 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,

@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在,在运行时可以通过反射获取到

1.2、@Target:定义注解的作用目标

@Target(ElementType.TYPE) //接口、类、枚举、注解

@Target(ElementType.FIELD) //字段、枚举的常量

@Target(ElementType.METHOD) //方法

@Target(ElementType.PARAMETER) //方法参数

@Target(ElementType.CONSTRUCTOR) //构造函数

@Target(ElementType.LOCAL_VARIABLE)//局部变量

@Target(ElementType.ANNOTATION_TYPE)//注解

@Target(ElementType.PACKAGE) ///包

由以上的源码可以知道,他的elementType 可以有多个,一个注解可以为类的,方法的,字段的等等

1.3、@Document:说明该注解将被包含在javadoc中。

1.4、@Inherited:说明子类可以继承父类中的该注解。

如何写好java代码注释

写代码的时候,有时候,你需要写一些注释,把内容相互关联起来,方便自己或别人看的时候,可以直接找到你关联的代码类或者啥的。

这个时候,{@link}与@see,这2个javadoc注解就派上用场了,

不管他具体有什么功能,咱就只管一个,他可以链接代码,让注释看的更清楚易懂。方便你我他。

@see 标签允许用户引用其他类的文档。具体使用方式如下:

@see classname

@see fully-qualified-classname

@see fully-qualified-classname#方法名称

@see fully-qualified-classname#属性名称

我在使用的时候,发现这个只能单独一行顶头写,如果不顶头写就不管用了,没了链接的效果。

但是,{@link}这个却可以随便放。

具体使用方法和上面那个@see是一样的。

实际效果,看下面的图

java 怎样给源代码添加注释

1、单行(single-line)--短注释://……

单独行注释:在代码中单起一行注释,

注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。

注释格式:/*

注释内容

*/

行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。

注释格式://

注释内容

行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。

注释格式:代码

+

8(至少4)个空格

+

//

注释内容

2、块(block)--块注释:/*……*/

注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成:

/*

*

注释内容

*/

3、文档注释:/**……*/

注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符

/**......*/

...


文章题目:java代码方法注释,Java代码注释
标题来源:http://kswsj.cn/article/hdgsig.html

其他资讯