java 文档注释的使用

文档注释的使用:

  1. 文档注释的作用:将来我们给别人一个开发好的类,如何让别人快速了解呢?

​ 我们文档注释的内容可以根据 javadoc 命令生成一个文档(api文档)

​ 别人拿到这个文档,就能快速对此类、及类中的功能进行快速的了解

  1. 命令: javadoc -d 要生成的文件夹名字 -author 此处写作者名 -version 此处写版本 文件夹名 .java

​ (运行此命令后,程序会在路径文件夹中自动生成一个api文档)

实例效果:


/**
	此类是Java的入门程序
	@author 涛哥
	@version  v1.0

*/
public class demo02helloword{
	/**
		main 是一个方法,是程序的入口,虚拟机(jvm)执行程序都是从main方法开始执行的
	

	*/
	public static void main(String[] args){
		System.out.print("hello word!");
	}

}

posted @ 2025-04-14 21:28  ananch  阅读(8)  评论(0)    收藏  举报