Eclipse打jar包与JavaDOC文档的生成

补充知识点------Eclipse打jar包与JavaDOC文档的生成

1、Eclipse如何打jar包,如何运行jar包

Java当中编写的Java代码,Java类、方法、接口这些东西就是项目中相关内容,到时候我们需要把代码提供给甲方、或者是我们需要运行我们编写的代码,我们总不能给甲方安装一个Eclipse开发环境,然后在开发环境中运行。我们一般是将编写好的Java代码打包称为一个jar包(是Java中一种特殊的压缩包,压缩包中存放的是Java中所有class二进制字节码文件以及项目中一些静态资源),把jar包给了甲方或者我们直接运行jar包就ok了。

打包方式:项目名--->export--->java--->jar file

运行方式:在命令行执行命令运行

java -jar xxx.jar包的路径 需要我们在打jar包时指定main-class文件

java -cp xxx.jar包的路径 全限定类名

2、JavaDOC文档

在编写项目的时候,我们自己定义很多的java类、方法、接口等等,编写的代码在很多情况下可不是我们自己看的,我们需要给甲方、或者是后来者查看,但是如果直接给他们看源代码的话,有点复杂了,源代码里面的东西说白了,挺乱的。因此Java给我们提供了一种注释语法:文档注释/** */,可以通过文档注释生成项目中的API文档,这样的话用户就不要看源码中注释了,只需要看API文档,就可以掌握项目中所有代码的含义。

Java文档注释中可以加一些注解去详细描述Java类和方法:

@author 作者(用于类和方法)

@since 版本---从哪个版本开始有的(用于类和方法)

@see 全限定类名 这个类和see中的类是有关系的(用于类和方法)

@version 类的版本(用于类和方法)

@param 参数名 参数注释 方法中形参的含义和注释(用于方法)

@return 注释 方法的返回值的注释(用于方法)

生成JavaDOC文档方式:项目名--->export--->java--->javadoc

文档生成后,点击index.html进行查看

即JavaDOC文档生成!

相关推荐
代码调试师6 小时前
【毕设分享】springboot攀枝花生鲜电商平台58990
java·vue.js·spring boot·后端·架构·eclipse·课程设计
老猿讲编程1 天前
【Eclipse OpenSOVD学习之十四】差距清单与演进建议
学习·rust·eclipse·车载·sovd
老猿讲编程1 天前
【Eclipse OpenSOVD学习之十一】网关二进制与部署
学习·中间件·rust·eclipse·汽车
老猿讲编程1 天前
【Eclipse OpenSOVD学习之十】客户端 SDK
学习·eclipse·嵌入式软件·车载·sovd
Sayai1 天前
不重新打包,vim 直接改 jar 包内的前端文件:原理、步骤与避坑
前端·vim·jar
老猿讲编程2 天前
【Eclipse OpenSOVD学习之六】 数据访问层(DataProvider)
学习·eclipse·嵌入式软件·车载·sovd
骇客野人2 天前
SpringBoot数十Jar包批量生产部署落地实施方案(Shell+Systemd完整版)
spring boot·后端·jar
老猿讲编程2 天前
【Eclipse OpenSOVD学习之五】拓扑引擎(Topology)
学习·rust·eclipse·sovd
hm宋3 天前
Canal 升级 jar 包操作文档(以升级 FastJSON 为例)
java·canal·jar
老猿讲编程4 天前
【Eclipse OpenSOVD学习之二】 SOVD 协议原理与标准背景
学习·eclipse·嵌入式软件·车载·sovd