「java的注解怎么写」JAVA怎么注释
今天给各位分享java的注解怎么写的知识，其中也会对JAVA怎么注释进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！
本文目录一览：
如何写Java文档注释
如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西
本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释
业余时间整理，难免有遗漏或错误，如有发现欢迎指正
转载地址：网页链接
文档注释概览
“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。
文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。
比如：
/**这是文档注释*/
/* 这是一般注释*/
// 这是一般注释
在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。
此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。
文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了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
*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代码注释
写代码的时候，有时候，你需要写一些注释，把内容相互关联起来，方便自己或别人看的时候，可以直接找到你关联的代码类或者啥的。
这个时候，{@link}与@see，这2个javadoc注解就派上用场了，
不管他具体有什么功能，咱就只管一个，他可以链接代码，让注释看的更清楚易懂。方便你我他。
@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称
我在使用的时候，发现这个只能单独一行顶头写，如果不顶头写就不管用了，没了链接的效果。
但是，{@link}这个却可以随便放。
具体使用方法和上面那个@see是一样的。
实际效果，看下面的图
java 语句如何注释
单行注释 // 快捷键 Ctrl+/
// M4_4aaForm fr = (M4_4aaForm) form;
多行注释 /*
*
*/
生成帮助文档的注释
/**
* Function: Action実行br
*
* Produce Describe:
*
* @param mapping
* @param form
* @param request
* @param response
* @return
* @throws SysException
* @throws DBException
*/
java的注解怎么写的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于JAVA怎么注释、java的注解怎么写的信息别忘了在本站进行查找喔。
发布于：2022-12-01，除非注明，否则均为原创文章，转载请注明出处。