在cmd把文档注释生成API文档

已于 2022-05-03 10:48:18 修改
阅读量437 收藏
点赞数
分类专栏： JavaSE 文章标签： java 开发语言
于 2022-05-03 10:40:51 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/pacong/article/details/124551526
版权
文档注释是Java中用于生成API帮助文档的一种规范，通过Javadoc命令可以将这些注释转化为HTML文件。主要针对非私有的类、变量和方法进行注释，便于他人理解和维护。使用Javadoc时，需要先有包含文档注释的Java源代码，然后在命令行输入`javadoc -d apidoc Date.java`，成功后会在apidoc目录下生成HTML文档，其中index.html为入口点。
摘要由CSDN通过智能技术生成

在cmd把文档注释生成API文档

文档注释是什么？

文档注释就是指这种注释内容能够生成API帮助文档，JDK中javadoc命令能够提取这些注释信息并生成HTML文件。文档注释主要对类（或接口）、实例变量、静态变量、实例方法和静态方法等进行注释。

提示：文档是要给别人看的帮助文档，一般注释的实例变量、静态变量、实例方法和静态方法都
应该是非私有的，那些只给自己看的内容可以不用文档注释。

为什么要用文档注释？

文档注释是一套注释规范，使用JDK中javadoc命令生成HTML文件，方便维护和使用。
文档注释一般是给一些看不到源代码的人看的帮助文档。

怎么做

1、要有一个java文档
在这里插入图片描述

在这里插入图片描述

2.输入命令

javadoc -d apidoc Date.java
在这里插入图片描述

结果

得到一个生成的文件夹
如果生成成功则在当前apidoc目录下生成很多HTML文件，其中的index.html文件是文档的入口，双击此文件
在这里插入图片描述在这里插入图片描述
在这里插入图片描述

pacong
关注
专栏目录
html api doc 模板,使用apidoc生成实用炫酷吊炸天的api文档
weixin_39707478的博客
06-22 678
为什么要用apidocapidoc根据其自定义注释语法自动生成api文档，我们只需要把代码中的注释按照其语法来写就能生成需要的文档，不需要手动写markdown。apidoc生成的文档相比markdown，漂亮直观又实用。如果API需要修改或者更新，直接修改代码的注释中即可。apidoc核心思路，文档与代码合一，修改代码就是修改文档，方便又实用。可以配合grunt使用，使自动化生成文档更加智能，支...
gin-swagger生成API文档
一生太短,只够爱一个人
06-25 462
导包 ​ go get -u github.com/swaggo/swag/cmd/swag 在main.go上加入主注释 // @title 希科志愿者项目 // @version 1.0 // @description 希科志愿者项目接口文档 // @host 8083 // @BasePath /api/v1 在接口对应的func上加入api注释 // Create // @Summary 创建召回 // @Tags 召回 // @accept json // @Param Proje..
注释生成Api文档
weixin_33923148的博客
09-23 309
1.开发背景 最近一直在写dubbo接口，以前总是用word文档写接口描述然后发给别人。现在太多了，而且跟别人对接联调的人家急着用，根本没时间去写word文档。那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象，但是并不熟悉，加上没有很强烈的要去使用的意图，所以一直没有弄。今天要感谢公司的大神，大家都叫他欧神，神一样的男人。让我用文档注释。然后就知道怎么弄了，以下是生成的流...
java_使用注释生成API文档
随手记的笔记
11-04 247
文章目录第一步：写注释第二步：Tools->Generate JavaDoc Scope报错java.lang.IllegalArgumentException 第一步：写注释 方法：/** + 空格 第二步：Tools->Generate JavaDoc Scope 报错java.lang.IllegalArgumentException 在java5以后就不用配置classpath环境变量了，把他删除就不会报错了。 ...
html帮助文件如何批注,下列命令中,可以将文档注释提取出来生成帮助文档的是()...
weixin_26717737的博客
06-26 316
摘要：下列星尔习通(南军事雅学理论答案_超开版考试。中可注释智慧语蜕变课颠覆的英答案到传统树知课后。文档文档和播通话中国(慕_普及答语音音发案大学声_试题课)。...下列星尔习通(南军事雅学理论答案_超开版考试。命令中国末答案_期路(大学_电上)。中可注释智慧语蜕变课颠覆的英答案到传统树知课后。学习号公众体育通_题库超星。国概网课到A答案客源况知。活小共享知到P健答案处方康生。文档文档和播通话中国...
注释（文档注释）与API文档
qq_45554909的博客
12-01 214
1、 注释 分类： 作用： 单行注释和多行注释的作用： ① 对所写的程序进行解释说明，增强可读性。方便自己，方便别人 ② 调试所写的代码 文档注释的使用： 注释内容可以被JDK提供的工具 javadoc 所解析，生成一套以网页文件形式体现的该程序的说明文档。 特点： 单行注释和多行注释，注释了的内容不参与编译。 换句话说，编译以后生成的.class结尾的字节码文件中不包含注释掉的信息 ==javadoc -d mydoc -author -version HelloWorld.java == 良好的编
2.文档注释和API
My vegetable has exploded.
01-21 728
Java的文档注释和API的生成
gin-swagger:使用 Swagger 2.0 自动生成 RESTful API 文档的 gin 中间件
07-24
gin 中间件使用 Swagger 2.0 自动生成 RESTful API 文档。 用法 开始使用它 向您的 API 源代码添加注释，。 使用以下命令下载 for Go： $ go get -u github.com/swaggo/swag/cmd/swag 在包含main.go文件的 Go 项目...
GoFrame框架中使用Swagger生成API文档
qq_39297673的博客
08-04 850
第一步: 下载插件 文档链接 go get github.com/gogf/swagger 第二步：为 API 添加 swagger语法注释 (照着下图依葫芦画瓢即可) swagger语法注释例子 swagger相关语法 第三步: 在 main.go中 填充如下代码 第四步:在当前项目下执行 gf swagger --pack 第五步: 在浏览器访问 http://localhost:8199/swagger ...
swag:使用Swagger 2.0 for Go自动生成RESTful API文档
04-28
Swag将Go注释转换为Swagger文档2.0。 我们已经为流行的创建了各种插件。 这使您可以快速与现有Go项目集成（使用Swagger UI）。 内容 支持的Web框架 如何与杜松子酒一起使用 实施状况 声明式注释格式 常规API信息 ...
自动生成头注释文件
正心 诚意 修身
04-02 1600
自动生成 头部注释 IDE VS2013
java文档注释--CMD命令下的javadoc的用法
weixin_43893814的博客
07-27 452
[java文档注释–CMD命令下的javadoc的用法] Java中有三种注释方式。前两种分别是 // 和 /* */，主要用于代码的注释，以此来方便代码的可读性。第三种被称作说明注释或文档注释，它以 /** 开始，以 ***/**结束，文档注释允许你在程序中嵌入关于程序的信息，有了这个注释就可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。 2.文档注释的格式 /** * … * … */ 在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。 之后，你可以包含一个或多
可以生成自动文档的注释
斜阳雨陌
04-05 833
使用/**和*/可以用来自动的生成文档。 这种注释以/**开头，以*/结尾
ubuntu使用python调用C语言函数
源代码杀手的博客
09-11 462
.c文件 /* test.c */ #include <stdio.h> int func(int a) { return a*a; } int main(int argc, char **argv) { int x; sscanf(argv[1], "%d", &x); printf("%d\n", func(x)); return 0; } .py文件 #!/usr/bin/env python #
java文档注释——生成帮助文档
一纸春秋的博客
10-13 2838
package NoteDemo; /**这个类里面有一个方法 * @author zhang * @version java1.8 */ public class demo1 { /** * 该类的无参构造方法 */ public demo1() { } /** *获取两数之和 * @param a 加数 * @param b 被加数 * @return 经过if语句判断后返回的String值
JavaDOC 文档注释（cmd生成&idea生成）
TRasdzz的博客
07-09 441
JavaDOC 文档注释 给Java类添加注释信息然后通过javadoc命令生成自己的api帮助文档 jdk api帮助文档 参数信息 @author 作者名 @vision 版本号 @since 指名需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 /** * @author TRasdzz * @version 1.0 * @date 2020/7/8 10:20 * */ public class Doc { S
CMD文件注释
w6028819321的专栏
07-08 5121
CMD注释形式形式如下：      1、:: 注释内容
Java的三种注释，和文档注释的生成文档说明
Mikchy的博客
06-06 3281
一、单行注释 二、多行注释 三、文档注释 编写注释的原因 编写程序时总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途、某个方法的功能，以及该方法的参数和返回值的数据类型及意义等。 编写注释的原因及意义如下： 为了更好的阅读自己编写的代码，建议添加这注释。自己写的代码，可能过一段时间回顾的时候，就变得不熟悉。这个时候，注释就起到了很好的帮助作用。 可读性第一，效率...
Eclipse文档注释生成doc方法
繁星点点~
11-30 6806
Eclipse文档注释生成doc方法 1.项目-->右键菜单Export-->Java下Javadoc-->next： javadoc command:就是要调用的javadoc.exe,在java安装位置中； use standarddoclet:就是要生成到的目录，自定义一个文件夹作为存放目录[不然一大堆]； 默认即可next-->再next--> 【注意注意】此时如
idea文档注释快捷键失效
最新发布
07-14
默认情况下，文档注释的快捷键是 `Ctrl + Shift + /`（Windows）或 `Cmd + Shift + /`（Mac）。如果你修改过快捷键配置，可以在设置中查看或重新设置快捷键。 2. 检查注释模板：在使用文档注释快捷键之前，请确保你...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值