javadoc命令生成文档注释

最新推荐文章于 2023-10-24 23:43:29 发布
最新推荐文章于 2023-10-24 23:43:29 发布
阅读量1.5k 收藏 7
点赞数
分类专栏： JAVA 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_48434899/article/details/121318664
版权
本文详细分析了HelloWorld程序的代码格式，强调了java语言的特性。介绍了javadoc工具的使用，包括如何生成文档注释及解决GBK编码问题。通过实例展示了未使用javadoc和使用后的代码注释差异，帮助读者理解javadoc在生成文档注释方面的作用。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

文章目录

HelloWorld的程序分析

写

代码格式

java代码的位置
java是严格区分大小写的
java是一种自由格式的语言
代码分为结构定义语句和功能执行语句
功能执行语句的最后必须用分号隔开

javadoc

在命令窗口,java所在文件夹下,
输入javadoc *.java;表示将此文件夹中的java文件都生成文档注释
也可javadoc HelloWorld.java;生成单个java文件的文档注释

javadoc的使用方式

javadoc -help;此命令可以显示javadoc如何使用
在这里插入图片描述
在这里插入图片描述

GBK编码问题

当输入javadoc生成文档注释的时候,如果出现GBK编码错误.
这是因为java编辑时使用的编码格式与cmd命令窗口的编码格式不一致造成的.
这时只需要点击"HelloWorld.java文件"编辑,之后另存为,如图所示.
在这里插入图片描述
在这里插入图片描述
编码"ANSI"对应的就是GBK编码格式.

使用javadoc形成文档注释

未使用时
在这里插入图片描述
使用"javadoc HelloWorld.java"后;
在这里插入图片描述
在这里插入图片描述
点击"index.html"看文档注释.
在这里插入图片描述

Java基础12：使用Javadoc命令生成文档
weixin_46507947的博客
07-30 711
一、Java文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。说明注释允许你在程序中嵌入关于程序的信息。你可以使用 Javadoc 工具软件来生成信息，并输出到HTML文件中。 二、文档注释的格式 /** * ......... * ......... */ 在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。 之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须...
JavaDoc【注释】生成API（开发文档）详解
最新发布
kertnudserf56968的博客
02-13 2290
Javadoc 是 Java 自带的一种工具，其可以从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
javadoc 生成注释 和 检查注释的文档
03-10
欢迎下载浏览
Javadoc生成注释文档
weixin_54690126的博客
11-26 860
javadoc命令生成api文档
文档注释，javaDoc生成文档
2301_78740967的博客
10-24 216
在窗口中输入javadoc -encoding UTF-8 -charset UTF-8 DOC.java命令。就会生成很多文件，我们打开其中index（首页）打开后和在官方中的很像，其中有很多我们设置的参数。JavaDos命令是用来生成自己API文档的。在文件位置左边加上cmd空格打开cmd窗口。我们先在JDEA中把文件所在位置打开。//加在方法上就是方法的注释。该参数为了减少出现乱码问题。//加在类上面就是类的注释。2用IDEA生成dos文档。在之后点OK后即生成文件。中间是生成文件的位置。
javaDoc文档注释（命令行生成java文档）
风也温柔☆的博客
01-07 364
1、编写文档注释，cmd打开 2、格式 ：javaDoc 参数 java文档 javadoc -encoding UTF-8 -charset UTF-8 Doc.java javadoc 文档编辑 -encoding UTF-8 -charset UTF-8 中文显示不出现编码错误 Doc.java 类 3、生成index.html文档，点击 ...
JavaDoc使用注释
PowerFedora的专栏
05-22 1113
对于软件工程来说代码的编写并不是唯一重要的事情。文档编写的重要性不亚于程序代码本身。如果代码与文档是分离的，那么在每次修改代码时，都需要修改相应的文档就会是一件相当麻烦的事情。所以我们通过javadoc将代码同文档“连接”起来。Javadoc是什么？javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一
JAVA文档化注释与javadoc命令
wxckjm的博客
01-13 559
一、JAVA注释 JAVA的注释分为：单行注释、多行注释和文档化注释。其中前两种注释基本每一种编程语言都有，文档化注释是JAVA所独有的，本文详细介绍文档化注释 1、文档化注释的格式 /** @author lijingming @version 1.000 这是JAVA文档化注释 */ public class HelloJava{ /** 这也是一个JAVA文档化注释 这是main方法，是程序的入口 这是我的第一个JAVA程序，我非常开心 ...
JAVADOC命令生成注释文档API
LANCE的博客
06-13 5287
输入javadoc -help 查看命令具体参数和帮助javadoc -d apidoc_directory -windowtitle 测试 -doctitle JAVADOC生成测试文档API -header 小爷的所有类 -author -version *.java//test1.java package TEST1; /** ********************************...
javadoc生成注释文档
xin053
05-13 5211
一、javadoc
java注释文档的生成
iWuxingyun的博客
09-16 811
javadoc 注释 javadoc注释以”/**“开始以”*/”结束。里面可以包含普通文本，HTML标记和javadoc标记，javadoc只处理源文件中在类/接口定义，方法，域，构造器之前的注释，而忽略为与其他地方的注释。举例如下： /** *第一个程序--<b>helloWorld</b> *@author sam *@version 1.0 */ public class myHelloW
JavaDoc生成文档（文档注释前面说注释的时候留过概念）
promiseMSummer的博客
02-05 624
JavaDoc生成文档（文档注释） 参数信息： @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 可以在网上搜：jdk帮助文档 javadoc命令是用来生成自己的API文档的 IDEA里就可以写一个自己的API文档如下 除了这些，我们还可以做更多操作，比如： 抛出异常 ...
如何通过javadoc命令生成.java源代码中的注释文档
Elsa~的博客
06-21 939
第一步：只有以[/**]开头[*/]结尾的注释格式才会生成注释文档，代码如下： /** *@author Elsa *@version 1.0 *@date 2020-6-21 */ public class Test { public static void main(String[] args) { System.out.println("Hello World!"); } } 第二步：选择Test.java文件所在的路径(小编这里的文件放在了桌面上），然后打开DOS命
Easy Javadoc插件：快速生成javadoc文档注释
weixin_44421461的博客
07-04 1179
点击上方“Java基基”，选择“设为星标”做积极的人，而不是积极废人！每天14:00更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络应用框架 Netty 源码解析消息中间件 RocketMQ 源码解析数据库中间件 Sharding-JDBC 和 MyCAT 源码解析...
Java之生成文档注释
哈希不Map的博客
09-04 1267
在实际开发中，我们经常需要生成文档注释，下面简单记录一下如何生成文档注释，以下是使用EditPlus编写的java文档生成的注释。 帮助文档: 1)使用JDK,JDK中类有很多,都可以使用,了解这些类的使用方式,类的功能,变量,方法,怎么使用, JDK给开发人员提供了帮助文档 API 2)自己的项目中,开发的功能,需要给客户提供对应的操作手册,方便客户进行功能的运行 注释: 文档注释,注释中包含了...
IDEA插件系列（29）：Easy Javadoc插件——快速生成javadoc文档注释
热门推荐
二木成林
08-17 3万+
1.插件介绍 Easy Javadoc插件。 能帮助java开发者自动生成javadoc文档注释。如下： 2.安装方式 第一种安装方式是在线下载安装插件。 第二种安装方式是使用离线插件进行安装。 插件下载地址：https://plugins.jetbrains.com/plugin/12977-easy-javadoc 3.使用方法 可以直接查阅官方的使用说明，是中文文档。 Windows系统下的idea安装该插件后启动的默认快捷键如下： 快捷键 作用域 说明 .
Javadoc（文档注释）
m0_69505153的博客
02-23 320
Javadoc（文档注释）
如何生成文档注释
qq_25447799的博客
06-28 361
Java文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /**、 开始，以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。 说明注释，使你更加方便的记录你的程序信息。 第一步：借助javadoc工具 查找文档注释： 第二步：将文档注释存储在一个文件夹中： ...
命令行生成java API注释文档
可能没带脑子，所以要记下来
12-24 2545
1.进入java文件所在的目录 例：文件在E盘：命令行输入e: 回车 2.输入一下命令即可： javadoc -d apidoc -windowtitle 测试 -doctitle 学习javadoc工具的测试API文档 -header 我的类 -version -author *World.java -d:文件存储位置; -windowtitle:窗口标题; -doctitle:文本...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值