锐客网

  1. 首页 > 生活百科 > it技术 > >

java中代码注释有哪些 java代码中可以使用注释方式

IT技术注释

java中的注释可分为三种类型Java中三种类型的注释：
单行注释：// 注释内容
多行注释：/*... 注释内容....*/
文本注释：/**.. 注释内容....*/
代码注释是架起程序设计者与程序阅读者之间的通信桥梁 ， 最大限度的提高团队开发合作效率 。也是程序代码可维护性的重要环节之一 。所以不是为写注释而写注释 。
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释 。
扩展资料：
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等 。
参考资料来源：百度百科-java注释
请列出java中的注释在Java里面主要有三种注释java中代码注释有哪些：行注释、段落注释、文档注释
1)行注释：行注释也成为单行注释java中代码注释有哪些，行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明
2)段注释：段注释也成为多行注释java中代码注释有哪些，通常是当说明文字比较长的时候的注释方法
3)文档注释：文档注释是Java里面的一个比较厉害的功能，它可以用于注释类、属性、方法等说明，而且通过JDK工具javadoc直接生成相关文档，文档注释的基本格式为“/**...*/”，不仅仅如此，文档注释本身还存在语法
java 中的几种注释方式我看动力节点的java基础大全301集教中的三种注释方法：
1、单行注释//注释的内容
2、多行注释/*......*/
3、/**......*/，这种方式和第二种方式相似 。这种格式是为了便于javadoc程序自动生成文档 。
下面介绍一下Javadoc的标记：
特别声明：
（1）javadoc针对public类生成注释文档
（2）javadoc只能在public、protected修饰的方法或者属性之上
（3）javadoc注释的格式化：前导*号和HTML标签
（4）javadoc注释要仅靠在类、属性、方法之前
下面主要举例说明第三种注释的应用：
（1）首先编写.java文件
（2）在命令行中执行以下dos命令：
javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记：是@开头的，对javadoc而言，特殊的标记 。
（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件
附上代码：
[java] view plain copy
span style="font-size:18px;"*/
/**javadoc注释的内容
*/
public class Hello{
/**属性上的注释*/
public String name;
/**这是main方法,是程序的入口
*@param args 用户输入参数
*/
public static void main(String[] args){
System.out.println("Hello World!");
f1();
}
/** 这是第1个方法,其作用是...*/
public static void f1(){
System.out.println("f1()！");
}
}/span
[java] view plain copy
span style="font-size:18px;"import java.io.IOException;
/**javadoc注释内容
*@since 1.0
*@version 1.1
*@author Blue Jey
【java中代码注释有哪些 java代码中可以使用注释方式】*br链接到另一个文档{@link Hello},就这些
*see Hello
*/
public class HelloWorld{
/**非public，protected 属性上的注释不生成*/
public String name;
/**这是main方法，是程序的入口
*@param args 用户输入的参数，是数组
*@throws IOException main方法io异常
*/
public static void main(String args[]) throws IOException{
System.out.println("hello World!");
f1();
f2(1);
}
/**这是第一个方法，其作用是....
*@deprecated 从版本1.2开始，不再建议使用此方法
*/
public static void f1(){
System.out.println("fl()!");
}
/**这是第二个方法，其作用是....
*@return 返回是否OK
*@param i 输入参数i
*@see Hello
*@throws IOException io异常
*/
public static String f2(int i)throws IOException{
System.out.println("f1()!");
return "OK";
}
} /span
注意：
如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author
javadoc -version -author -d doc *.java
（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）
java里的注解都有哪些？都有什么用处?。?/h2>注释有 3 中基本类型a. 标记注释 -- 没有变量，只有名称标识 。例如 @annotationb. 单一值注释 -- 在标记注释的基础上提供一段数据 。如 @annotation(“data”)c. 完整注释 -- 可以包括多个数据成员，每个数据成员由名称和值构成 。@annotation(val1="data1",val2="data2")Java 中提供 3 个内置注释类型a. Override，只能用于方法 ( 不能用于类，包声明或者其他构造 )作用：可以保证编译时候 Override 函数的声明正确性用法： @Overridepublic void fun(){..}b.Deprecated 同样只能作用与方法作用：对不应再使用的方法进行注解用法： @Deprecated public void fun{...} // 它们说这个注释跟函数要同一行c.SupressWarnings 可以注释一段代码作用：关闭特定的警告信息，例如你在使用泛型的时候未指定类型用法： @SupressWarnings(value=https://www.04ip.com/post/{"unchecked"}).. 代码Java 中还提供了四种元注释，专门负责注释其他的注释@Target 表示该注释可以用于什么地方 。可用的 ElementType 参数包括：CONSTRUCTOR : 构造器的声明FIELD : 域声明 ( 包括 enum 实例 )LOCAL_VARIABLE : 局部变量声明METHOD : 方法声明PACKAGE : 包声明PARAMETER : 参数声明TYPE : 类、接口 ( 包括注解类型 ) 或 enum 声明@Retention 表示需要在什么级别保存该注释信息 。可选的 RetentionPoicy 参数包括：SOURCE : 注释将被编译器丢掉CLASS : 注释在 class 文件中可用，但会被 VM 丢弃RUNTIME : VM 将在运行时也保留注释，因此可以通过反射机制读取注释的信息 。
java开发中常用的注解有哪些Java 注解全面解析，学习java做一个java工程师不但待遇高 ， 而且前途无可限量 。为什么这样说呢？因为java程序语言作为最流行的计算机开发语言之一，几乎所有的系统、软件、app、网页等都是需要用到java的 。
1.基本语法
注解定义看起来很像接口的定义 。事实上，与其他任何接口一样，注解也将会编译成class文件 。
@Target(ElementType.Method)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
除了@符号以外 ， @Test的定义很像一个空的接口 。定义注解时，需要一些元注解（meta－annotation） ， 如@Target和@Retention
@Target用来定义注解将应用于什么地方（如一个方法或者一个域）
@Retention用来定义注解在哪一个级别可用，在源代码中（source），类文件中（class）或者运行时（runtime）
在注解中，一般都会包含一些元素以表示某些值 。当分析处理注解时，程序可以利用这些值 。没有元素的注解称为标记注解（marker annotation）
四种元注解，元注解专职负责注解其他的注解，所以这四种注解的Target值都是ElementType.ANNOTATION_TYPE
注解 说明
@Target 表示该注解可以用在什么地方，由ElementType枚举定义
CONSTRUCTOR：构造器的声明
FIELD：域声明（包括enum实例）
LOCAL_VARIABLE：局部变量声明
METHOD：方法声明
PACKAGE：包声明
PARAMETER：参数声明
TYPE：类、接口（包括注解类型）或enum声明
ANNOTATION_TYPE：注解声明（应用于另一个注解上）
TYPE_PARAMETER：类型参数声明（1.8新加入）
TYPE_USE：类型使用声明（1.8新加入）
PS：当注解未指定Target值时 ， 此注解可以使用任何元素之上 ， 就是上面的类型
@Retention 表示需要在什么级别保存该注解信息，由RetentionPolicy枚举定义
SOURCE：注解将被编译器丢弃（该类型的注解信息只会保留在源码里，源码经过编译后，注解信息会被丢弃，不会保留在编译好的class文件里）
CLASS：注解在class文件中可用 ， 但会被VM丢弃（该类型的注解信息会保留在源码里和class文件里 ， 在执行的时候 ， 不会加载到虚拟机（JVM）中）
RUNTIME：VM将在运行期也保留注解信息 ， 因此可以通过反射机制读取注解的信息（源码、class文件和执行的时候都有注解的信息）
PS：当注解未定义Retention值时 ， 默认值是CLASS
@Documented 表示注解会被包含在javaapi文档中
@Inherited 允许子类继承父类的注解
2. 注解元素
– 注解元素可用的类型如下：
– 所有基本类型（int,float,boolean,byte,double,char,long,short）
– String
– Class
– enum
– Annotation
– 以上类型的数组
如果使用了其他类型，那编译器就会报错 。也不允许使用任何包装类型 。注解也可以作为元素的类型，也就是注解可以嵌套 。
元素的修饰符 ， 只能用public或default 。
– 默认值限制
编译器对元素的默认值有些过分挑剔 。首先 ， 元素不能有不确定的值 。也就是说 ， 元素必须要么具有默认值，要么在使用注解时提供元素的值 。
其次，对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值 。这就是限制 ， 这就造成处理器很难表现一个元素的存在或缺失状态 ， 因为每个注解的声明中，所有的元素都存在，并且都具有相应的值 。为了绕开这个限制，只能定义一些特殊的值，例如空字符串或负数，表示某个元素不存在 。
@Target(ElementType.Method)
@Retention(RetentionPolicy.RUNTIME)
public @interface MockNull {
public int id() default -1;
public String description() default “”;
}
3. 快捷方式
何为快捷方式呢？先来看下springMVC中的Controller注解
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
String value() default “”;
}
可以看见Target应用于类、接口、注解和枚举上，Retention策略为RUNTIME运行时期，有一个String类型的value元素 。平常使用的时候基本都是这样的：
@Controller(“/your/path”)
public class MockController { }
这就是快捷方式，省略了名－值对的这种语法 。下面给出详细解释：
注解中定义了名为value的元素，并且在应用该注解的时候，如果该元素是唯一需要赋值的一个元素 ， 那么此时无需使用名－值对的这种语法，而只需在括号内给出value元素所需的值即可 。这可以应用于任何合法类型的元素，当然了，这限制了元素名必须为value 。
4. JDK1.8注解增强
TYPE_PARAMETER和TYPE_USE
在JDK1.8中ElementType多了两个枚举成员 ， TYPE_PARAMETER和TYPE_USE，他们都是用来限定哪个类型可以进行注解 。举例来说，如果想要对泛型的类型参数进行注解：
public class AnnotationTypeParameter@TestTypeParam T {}
那么，在定义@TestTypeParam时，必须在@Target设置ElementType.TYPE_PARAMETER，表示这个注解可以用来标注类型参数 。例如：
@Target(ElementType.TYPE_PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestTypeParam {}
ElementType.TYPE_USE用于标注各种类型 ， 因此上面的例子也可以将TYPE_PARAMETER改为TYPE_USE，一个注解被设置为TYPE_USE，只要是类型名称，都可以进行注解 。例如有如下注解定义：
@Target(ElementType.TYPE_USE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
那么以下的使用注解都是可以的:
List@Test Comparable list1 = new ArrayList();
List? extends Comparable list2 = new ArrayList@Test Comparable();
@Test String text;
text = (@Test String)new Object();
java.util. @Test Scanner console;
console = new java.util.@Test Scanner(System.in);
PS：以上@Test注解都是在类型的右边，要注意区分1.8之前的枚举成员 ， 例如：
@Test java.lang.String text;
在上面这个例子中，显然是在进行text变量标注，所以还使用当前的@Target会编译错误 ， 应该加上ElementType.LOCAL_VARIABLE 。
@Repeatable注解
@Repeatable注解是JDK1.8新加入的，从名字意思就可以大概猜出他的意思（可重复的） 。可以在同一个位置重复相同的注解 。举例：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Filter {
String [] value();
}
如下进行注解使用:
@Filter({“/admin”,”/main”})
public class MainFilter { }
换一种风格:
@Filter(“/admin”)
@Filter(“/main”)
public class MainFilter {}
在JDK1.8还没出现之前，没有办法到达这种“风格”，使用1.8，可以如下定义@Filter：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Filters.class)
public @interface Filter {
Stringvalue();
}
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Filters {
Filter [] value();
}
实际上这是编译器的优化，使用@Repeatable时告诉编译器，使用@Filters来作为收集重复注解的容器，而每个@Filter存储各自指定的字符串值 。
JDK1.8在AnnotatedElement接口新增了getDeclaredAnnotationsByType和getAnnotationsByType，在指定@Repeatable的注解时，会寻找重复注解的容器中 。相对于，getDeclaredAnnotation和getAnnotation就不会处理@Repeatable注解 。举例如下：
@Filter(“/admin”)
@Filter(“/filter”)
public class FilterClass {
public static void main(String[] args) {
ClassFilterClass filterClassClass = FilterClass.class;
Filter[] annotationsByType = filterClassClass.getAnnotationsByType(Filter.class);
if (annotationsByType != null) {
for (Filter filter : annotationsByType) {
System.out.println(filter.value());
}
}
System.out.println(filterClassClass.getAnnotation(Filter.class));
}
}
日志如下:
/admin
/filter
null
望采纳！
Java注释有几种类型三种类型：
1、单选注释：符号是：//
2、块注释： 符号是： /**/ 可以跨多行
3、javadoc注释： 符号是： /***/ 可以跨多行java中代码注释有哪些， 生成javadoc时java中代码注释有哪些，这样java中代码注释有哪些的注释会被生成标准java中代码注释有哪些的javaapi注释 。
关于java中代码注释有哪些和java代码中可以使用注释方式的介绍到此就结束了 ， 不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站 。

    推荐阅读


    上一篇：安卓格机后怎么设置回去，安卓格机方法图片步骤

    下一篇：b站link直播录屏，b站录屏直播在哪