`
bearsorry
  • 浏览: 93596 次
  • 性别: Icon_minigender_2
  • 来自: 湖南
社区版块
存档分类
最新评论

将自己的代码导出成API文档

 
阅读更多

    这个其实早就讲过了的,只是自己懒得去动手做吧,今天好不容易想起来要去将自己的代码弄成API文档看看,结果发现之前讲的好像忘得差不多了,看来,做记录是很有必要的啊!

  现在在别人的帮助和自己的理解之下将这个东西捣腾出来,可能有很多原理还是木有弄懂吧,先把这个过程记录一下吧,以后有更深的而理解了再接着完善吧!

   这里主要要分两部分来说:将自己的代码导出成API文档和一个工程调用另一个工程里面的类的方法

一、将代码导出成API文档

   先选中你要导出的文件,右击选择export,再选择java里面的javadoc,再next,将javadoc command下面的目录选成我们当时装jdk的时候的那个jdk文件夹里面的lib文件夹里面的javadoc.exe,按确定,接下来就是对你要导出的文档包进行确认,并选择你要导出的路径,在按next,选择自己要导出来的东西,虽然那个里面还有好多东西看不太懂,但先知道这个过程再说吧!最后按下finish就OK了!这样你就可以在你存的位置看到你的API了~~~

    结果我看了一下我导出来的API文档,觉得那个样子的API是木有人愿意看的,看来我下一步的计划真的要重点推敲我的代码质量了···

二、一个工程引用另外一个工程的类及方法

    现在不是提倡开源么,是的,大家有什么好的程序,好的代码是可以相互学习的,那么怎么样将别人的源代码运用到自己的用eclipse编写出来的程序里面呢?!下面就是来说说这个方法吧!

    首先要将我们写的代码打包成jar文件,这个应该大家都比较熟悉了,就是将刚才选的javadoc改为选成JER File就行了,这里最重要的就是要把源代码也给打包成jar文件,好的,现在就是将刚才的jar包导入到你所需要用到的工程里面就行了!这个过程是这样的:每一个工程下面都有JRE Systemout Library,点击右键选择build path中的configure build path ,就在这个库里面添加刚才那个jar文件就行了!基本上就是这样的了,里面会有很多细节问题,但只要知道上面的这些过程,应该还是够我们现在所要用的范围了的!

    好了,也不晓得自己理解错了木有,反正我试验了之后是正确的,得到了我想要的结果,这个里面是还有很多东西需要我们去钻研,不要搞不好就将自己辛辛苦苦写的东西给整没啦!这个小的流程就介绍到这里吧~~~

0
3
分享到:
评论

相关推荐

    swagger导出静态API文档工具

    Swagger导出静态API文档工具是基于Swagger的一个实用工具,它是一个Maven工程,这意味着我们可以利用Maven的构建生命周期来自动化文档的生成过程。 首先,让我们了解Maven。Maven是一个项目管理工具,它通过读取...

    JavaDoc生成API文档(powernode document)(源代码和导出的文档)

    JavaDoc生成API文档(powernode document)(内含源代码和导出的文档) 1.1 JavaDoc概述 1.2 文档注释的格式 1.3 IDEA生成API文档 vaDoc是Java自带的一种工具,其可以从程序源代码中抽取类、方法、属性等注释形成一...

    springboot项目中json导出成标准接口文档到word(swagger样式)

    根据业务需求需要,需要将json格式的api信息【比如postman导出接口文档这类的】,导出成标准接口文档的word文件。 该平台是将一些好的第三方平台接口接入进来,供用户使用,每个用户下有可以使用的接口,可以根据...

    webapi文档生成,快速生成WebApi说明文档

    在提供的压缩包文件"ApiDoc"中,可能包含了这个WebAPI文档生成工具的所有资源,如配置文件、示例代码、文档模板等。使用时,开发者需要按照工具的说明进行配置,然后运行工具,生成对应的API文档。一般来说,这些...

    Awvs API接口文档

    整理网络资源,根据网络上的相关文档结合自己的实际操作整理的AWVS11的API接口文档,官方的API接口文档是商务付费的,所以只能自己整理。我所使用的接口测试工具为curl,curl的具体安装和相关参数请度娘。核心参考...

    js将HTML文本导出生成word文档

    在现代Web应用中,有时我们需要将网页上的内容导出为Word文档,以便用户可以离线查看或打印。本文将详细讲解如何使用JavaScript实现这一功能,主要依赖于两个JavaScript库:html2docx和FileSaver.js。这两个库可以...

    使用poi-api创建文件导出excel文档

    在本篇文章中,我们将深入探讨如何使用POI API创建文件并导出为Excel文档。 首先,我们需要理解Apache POI的基本概念。POI是“Poor Obfuscation Implementation”的缩写,它是一个开放源码的Java API,用于读取、...

    java报表API源代码(程序数据集、自定义函数和导出API)

    1. 熟悉Java基础和FineReport的API文档是使用这些源代码的前提。 2. 分析并理解`TableData`接口及其子类的实现,以便创建自定义数据源。 3. 实践自定义函数的编写,以适应特定的业务需求。 4. 学习导出API,掌握如何...

    WPS API帮助文档

    6. **数据导入导出**:可以将数据从外部源导入到文档中,或者将文档内容导出为其他格式,如CSV、XML等。 7. **打印和预览**:控制文档的打印设置,提供预览功能,确保文档打印效果符合预期。 **WPS API的使用步骤*...

    MySQL数据库表导出Word工具,生成数据库说明文档

    "MySQL数据库表导出Word工具"提供了一种便捷的方式,将数据库结构和内容转换为易于理解的Word文档,这对于开发、运维以及非技术背景的团队成员都非常有帮助。 首先,这个工具的主要功能是将MySQL数据库中的表结构和...

    利用JSP将数据导出到Word文档

    标题“利用JSP将数据导出到Word文档”涉及到的是在Web开发中如何使用Java Server Pages(JSP)技术来生成动态的Word文档。这种功能通常用于数据报告、记录保存或者用户需要下载结构化信息的场景。下面我们将深入探讨...

    TinyMCE富文本编辑器导出为word文档(JS实现)

    本示例着重讲解如何利用JavaScript技术将TinyMCE编辑器中的内容导出为Word文档,以便用户可以离线查看或进一步处理。 在TinyMCE编辑器中,内容是通过HTML代码存储的。因此,导出为Word文档的核心思路是将HTML转换为...

    百度统计DataAPI文档(内附PHP调用代码)

    Data API支持将百度统计中的数据以通用格式导出,助您以更灵活的方式分析百度统计中的数据,更好的挖掘数据中的价值。 此文档为百度统计官方提供,包括两个文件: dataapi-clent-php-1.0.0.zip dataapi开发文档_...

    快速生成某个lua文件对外的api

    8. **集成开发环境(IDE)插件**:高级的API生成工具可能会有配套的IDE插件,使得在编写代码的同时就可以实时预览API文档。 9. **自动化工作流**:在项目构建过程中,这个工具可能被集成到如Git钩子或持续集成系统...

    基于Java的开源API接口文档管理系统设计源码

    本项目是一个基于Java语言开发的API接口文档管理系统,包含213个文件,主要文件类型包括JAR包、图片、JavaScript脚本、CSS样式表、图片、Java源代码、JSP页面、XML配置文件、JSON配置文件、SQL数据库文件。...

    JqGrid中文API文档

    本中文API文档将帮助开发者深入理解并有效利用JqGrid的各项功能。 一、基本使用 JqGrid的使用始于HTML页面中的表格元素,通过设置`<table>`标签的`id`属性,JqGrid会绑定到这个表格。例如: ```html ...

    Swagger3生成API文档配置(Demo)

    总结,Swagger3是Spring Boot项目中用于生成API文档的强大工具,通过注解和配置,我们可以轻松地创建和管理RESTful API的文档。通过运行应用,我们可以利用Swagger UI进行接口的测试和调试,极大地提高了开发效率和...

    通过代码导出数据库结构,变成文档

    总结来说,通过代码导出数据库结构并生成文档是一种高效的方法,可以帮助我们更好地管理和共享数据库设计。借助Python等编程语言,结合合适的库和工具,我们可以实现自动化、标准化的数据库文档生成流程,提升工作...

    springboot-knife4j 实现API文档

    它允许开发者通过注解的方式在代码中添加元数据,这些元数据将被用来生成详细的API文档。 2. **Knife4j增强特性** - 用户友好的界面:相比Swagger UI,Knife4j提供了更符合中国开发者习惯的界面设计。 - 动态过滤...

    通过spring插件生成api注释文档

    首先,我们需要理解的是,Spring提供的这种插件通常基于JavaDoc或类似的技术,JavaDoc是一种用于生成API文档的标准化工具,它能够解析源代码中的Javadoc注释,并将这些注释转换成易于阅读的HTML文档。通过这种方式,...

Global site tag (gtag.js) - Google Analytics