一、为什么不写注释?
有些人认为只要方法名起得好,就不用写注释。
你写了注释,甚至还有一些人觉得你low。
个人认为,不写注释这只适用于简单的方法,在复杂的方法上该注释还是得注释。
即使是优美的方法名,也不一定能够完整地表达方法的功能和用途,
特别是对于复杂的算法或者涉及到较多的条件和约束的方法来说。
并且注释可以帮助其他程序员更好地理解代码的意图和实现,提高代码可读性和可维护性。
而且啊,Java源码中都有大量注释,能说Oracle他们Low嘛?不能吧。
所以说啊,写注释还是挺重要的。
你们会写注释么?
码鹿:啊,对对对,下次一定写。
二、我们顺便来回顾一下,JAVA学怎么写注释的。
单行注释:
使用//开头,用于注释单行代码或者注释在行尾。
int age = 20; // 定义一个年龄变量,赋值为20
多行注释:
使用/**/将多行注释扩起来,通常用于注释类、方法和变量等。
/**
* 定义一个Person类,包含name和age属性
*/
public class Person {
private String name;
private int age;
}
多行注释还有以下属性
@author:作者
@since:从哪个版本开始引入
@param:参数说明
@return:返回值说明
@throws/@exception:异常说明
/**
* 这是一个示例方法,返回两个整数之和。
* @param a 第一个整数
* @param b 第二个整数
* @return 两个整数之和
*/
public static int add(int a, int b) {
return a + b;
}
三、JavaDoc
JavaDoc 是 Java 自带的一种文档注释工具,它可以根据源代码中的注释生成 HTML 格式的 API 文档。
使用 javadoc 命令生成 API 文档,命令格式为:
javadoc [options] [packagenames] [sourcefiles] [@files]
四、相关知识:接口文档API工具
Swagger | |
OpenAPI3 | |
smartdoc | 零侵入 |
SpringDoc | 基于OpenAPI 3 |
knife4j |
好了,又水了一篇。