栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

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

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

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

在cmd把文档注释生成API文档 文档注释是什么?

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

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

为什么要用文档注释?

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

怎么做

1、要有一个java文档

2.输入命令

javadoc -d apidoc Date.java

结果

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

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/855237.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号