JAVAdoc,java javac javadoc
如何解决写爬虫IP受阻的问题？立即使用。
简介：
我们知道javadoc嵌入在JDK中，所以遵循javadoc规范绝对是java注释的正统。用javadoc帮助生成API文档是非常实用的。
(学习视频分享：java视频教程)
1.什么是评论？
添加注释是为了让代码更具可读性，减少团队协作的沟通成本。在一个团队里，你的代码更清晰，更易读，更规范，那么升职加薪肯定是你的，因为你可以兼容更多的人。
前段时间听到一句话：你是唯一能理解你代码的人，所以你是不可或缺的人。说这话的人都是脑残。他们只能阅读和理解自己写的代码。大家都讨厌。他们像孙子一样生活。每个人都需要孙子吗？
2.常见注释快捷方式
评论一行：//我就是行内容。
快捷键：ctrl/反向操作：ctrl/评论a块：/*我就是块内容*/
快捷键：ctrl shift/反向操作：ctrl shift \javadoc可识别注释：
/**
*我是评论。
*我也在评论。
*我还在评论，我们都能被javadoc认出来
*/3，javadoc规范
遵循javadoc规范，我们可以使用javadoc命令生成非常直观易读的API文档，非常方便。
我们程序中出现的注释可以有意识地分为两种，一种是简单的供我们自己阅读的注释，另一种是符合javadoc规范的注释，目的是生成易读的文档。
仔细阅读生成的API文档。我们需要解释三个部分，如图所示：
上面红框里的内容都是我加的评论。这是一个简单的Hello类，有以下源代码。有兴趣的话可以自己试试：
/**
* @作者XXXX
* @版本创建于2021年1月21日下午3:22:01
*
*/
公共类Hello {
/**
* main()方法的简要描述(后面的点是必不可少的)。
* p这是为了测试注释br
*没什么好解释的，只是说明可以出现在这里。
* @param args由系统匹配。没什么好说的。
*
*/
公共静态void main(String[] args) {
//TODO自动生成的方法存根
system . out . println( hello )；
}
/**
* havaReturn方法用于测试javadoc注释规范。
* p我发现只有有返回值的方法才能使用返回标签br。
*如果你不得不使用它而不返回，你只会在javadoc中报告一个错误。
* @param a输入的第一个int类型的参数
* @param b输入的第二个整型参数
* @返回两个数和运算的相加结果
*/
public int haveReturn(int a，int b){
int add=0；
add=a b；
return add
}
}有几个要点需要指出：
如果希望出现API文档的作者和版本，不仅要在程序注释中添加@author和@version(需要注意的是，在程序中多处注释@author在最终文档中只会显示一次，我建议只注释一次)，还要在编译时在dos命令中指出：
javadoc -d文件夹版本作者Hello.java
其中，-d folder是指你把生成的API文档(实际上是由很多网页组成的)放在folder文件夹中。当然，文件夹也可以是路径。
如何区分方法概要和方法细节？
/**
* main()方法的简要描述(后面的点是必不可少的)。
* p这是为了测试注释br
*没什么好解释的，只是说明可以出现在这里。
* @param args由系统匹配。没什么好说的。
*
*/
公共静态void main(String[] args) {
//TODO自动生成的方法存根
system . out . println( hello )；
}你一定发现关于方法的评论都是一堆。javadoc如何提取摘要？没错，就靠一个点(。).观察我评论中提到的点，那是提取摘要的关键。点是之前的总结，都是详细介绍(详细介绍包括总结)
如何控制生成的文档中注释的布局
我们在程序中可以控制的是注释的排版，但是这种排版是javadoc无法识别的。javadoc找到了一行注释，在只删除了*和空格之后，就把它全部传过去了。注意到生成的文档是HTML类型的，所以只需在程序中注释HTML语法就可以编辑API文档格式。不用太担心，因为我们只是用了一些简单的HTML语法，比如段落p，和换行符br。毕竟，评论
@param参数1描述(注意格式)
@return返回值描述(注意格式)
有返回值就写，没有就不要写。如果您这样做，您将报告一个错误。
实际上，编写类注释和方法注释非常简单。只要在类和方法前面点/* *然后回车，系统就会自动添加，我们也可以修改系统添加的方式。
如何修改新创建文件的内容，如何让自动完成的注释由我们控制(待办事项)
我们从标准的类文件中可以看到这一点：
众所周知，out是System类的一个属性(字段)，属于PrintStream类型。PrintStream类中定义了许多方法，这些自然是out方法。所以在定义out的时候，前面的注释里有很多@see，这是使用@see注释最好的地方。我们建议在定义类的字段时，如果字段是复合类型(尤其是自定义复合类型)，应该在前面注释。
相信大家对这两张图都很熟悉。第一个是写程序时光标可以出现的提示。如果您根据javadoc规范编写注释，这些极其有用的提示也会出现在您自己编写的程序中。第二个是java8 API文档中对String类中out字段的详细描述，这也是@see的功劳。你写了@see，你自己的项目API文档也有这样的注释。
推荐：java入门。以上是javadoc规范的详细内容。更多请关注我们的其他相关文章！
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。