二十三、生成帮助文档

2024-06-13 18:36
文章标签 文档 生成 帮助 二十三

本文主要是介绍二十三、生成帮助文档,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

二十一、Java工具类的创建
二十二、Jar包制作及使用
这一篇开始学习如何生成帮助文档。为什么要学习生成帮助文档
1、工具类已经制作好了,Java工具类的创建的类是一个.java文件,编译后成.class文件看不懂,所以需要对应的帮助文档,方便调用者快速了解一个类,相当于类的说明书

总结的说帮助文档就是类的说明书,学习Java的过程就是学习类的过程。

2、生成过程需要用到文档注释,其中可以通过一些注解,表示不同的内容,注解就是文档中出现的内容的解释

(1) 作者: @author  暴书源(2) 版本:  @version 1.0(3) 参数:  @param  用来对参数进行说明(4) 返回值:  @return 后面放返回值的说明

3、标注完成之后,进行帮助文档的生成

package com.test;
/*** @author 暴书源世界上最帅的程序员之一* @version 1.0* ArrayTool提供了一些数组操作的相关方法,包含了获取最大值、最小值、遍历、反转等功能*/
public class ArrayTool {private ArrayTool() {}/*** 用来获取最大值的方法:getMax* @param arr 表示需要传递一个数组,其中arr不能为null* @return 返回值就是最大值*/public static int getMax(int[] arr) {int max = arr[0];for (int i = 1; i < arr.length; i++) {if (max < arr[i]) {max = arr[i];}}return max;} /*** 用来获取最小值的方法:getMin* @param arr 表示需要传递一个数组,其中arr不能为null* @return 返回值就是最小值*/public static int getMin(int[] arr) {int min = arr[0];for (int i = 1; i < arr.length; i++) {if (min > arr[i]) {min = arr[i];}}return min;}
//    数组的两个元素交换/*** 数组元素交换的方法:swap* @param arr 表示要交换的数组,arr不能为null* @param i 表示要交换数组的元素的索引* @param j 表示要交换数组的元素的索引*/public static void swap(int[] arr,int i,int j){int temp = arr[i];arr[i] = arr[j];arr[j] = temp;}
//            数组的遍历/*** 打印数组中的每一个元素的方法:print* @param arr 表示要打印的数组,arr不能为null*/public static void print(int[] arr){for (int i = 0; i < arr.length; i++) {System.out.println(arr[i]);}}
//    数组的反转/*** 可以将数组元素反转的方法:reverse* @param arr 表示要反转的数组,arr不能为null*/public static void reverse(int[] arr){for(int i = 0,j = arr.length-1; i < j; i++,j--){swap(arr,i,j);}}
}

怎么生成帮助文档?

JDK提供了官方的CMD生成命令 javadoc 下面是官方给的,很长先别管我带大家做一下

用法: javadoc [options] [packagenames] [sourcefiles] [@files]-overview <file>HTML 文件读取概览文档-public                          仅显示 public 类和成员-protected                       显示 protected/public 类和成员 (默认值)-package                         显示 package/protected/public 类和成员-private                         显示所有类和成员-help                            显示命令行选项并退出-doclet <class>                  通过替代 doclet 生成输出-docletpath <path>               指定查找 doclet 类文件的位置-sourcepath <pathlist>           指定查找源文件的位置-classpath <pathlist>            指定查找用户类文件的位置-cp <pathlist>                   指定查找用户类文件的位置-exclude <pkglist>               指定要排除的程序包列表-subpackages <subpkglist>        指定要递归加载的子程序包-breakiterator                   计算带有 BreakIterator 的第一个语句-bootclasspath <pathlist>        覆盖由引导类加载器所加载的类文件的位置-source <release>                提供与指定发行版的源兼容性-extdirs <dirlist>               覆盖所安装扩展的位置-verbose                         输出有关 Javadoc 正在执行的操作的信息-locale <name>                   要使用的区域设置, 例如 en_US 或 en_US_WIN-encoding <name>                 源文件编码名称-quiet                           不显示状态消息-J<flag>                         直接将 <flag> 传递到运行时系统-X                               输出非标准选项的提要通过标准 doclet 提供:-d <directory>                   输出文件的目标目录-use                             创建类和程序包用法页面-version                         包含 @version 段-author                          包含 @author 段-docfilessubdirs                 递归复制文档文件子目录-splitindex                      将索引分为每个字母对应一个文件-windowtitle <text>              文档的浏览器窗口标题-doctitle <html-code>            包含概览页面的标题-header <html-code>              包含每个页面的页眉文本-footer <html-code>              包含每个页面的页脚文本-top    <html-code>              包含每个页面的顶部文本-bottom <html-code>              包含每个页面的底部文本-link <url>                      创建指向位于 <url> 的 javadoc 输出的链接-linkoffline <url> <url2>        利用位于 <url2> 的程序包列表链接至位于 <url> 的文档-excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。-group <name> <p1>:<p2>..        在概览页面中, 将指定的程序包分组-nocomment                       不生成说明和标记, 只生成声明。-nodeprecated                    不包含 @deprecated 信息-noqualifier <name1>:<name2>:... 输出中不包括指定限定符的列表。-nosince                         不包含 @since 信息-notimestamp                     不包含隐藏时间戳-nodeprecatedlist                不生成已过时的列表-notree                          不生成类分层结构-noindex                         不生成索引-nohelp                          不生成帮助链接-nonavbar                        不生成导航栏-serialwarn                      生成有关 @serial 标记的警告-tag <name>:<locations>:<header> 指定单个参数定制标记-taglet                          要注册的 Taglet 的全限定名称-tagletpath                      Taglet 的路径-charset <charset>               用于跨平台查看生成的文档的字符集。-helpfile <file>                 包含帮助链接所链接到的文件-linksource                      以 HTML 格式生成源文件-sourcetab <tab length>          指定源中每个制表符占据的空格数-keywords                        使程序包, 类和成员信息附带 HTML 元标记-stylesheetfile <path>           用于更改生成文档的样式的文件-docencoding <name>              指定输出的字符编码

找到自己的java文件所在位置
javadoc1
上图cmd回车之后显示如下页面
javadoc2
javadoc3
回车后
javadoc4

总结

D:\namespace\Demo01\src\main\java>javajavadoc 
-d D:\namespace\Demo01\src\main\java  
-encoding UTF-8 
-charset UTF-8 
-windowtitle "帮助文档"    ArrayTool.java

-d后面的参数是帮助文档的生成位置
-encoding后面的参数UTF-8是编码,如果不加上这个会导致无法识别中文
-charset用来设定字符集的编码
-windowtitile用来设置标题

最后看一下我们刚刚生成的DOC(java说明书)
在这里插入图片描述
这里还有方法的详细资料
是通过这些命令给的的详细资料

(1) 作者: @author  暴书源
(2) 版本:  @version 1.0
(3) 参数:  @param  用来对参数进行说明
(4) 返回值:  @return 后面放返回值的说明

在这里插入图片描述
学会了给点个赞 ,谢谢

这篇关于二十三、生成帮助文档的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1058100

相关文章

AI一键生成 PPT

AI一键生成 PPT 操作步骤 作为一名打工人,是不是经常需要制作各种PPT来分享我的生活和想法。但是,你们知道,有时候灵感来了,时间却不够用了!😩直到我发现了Kimi AI——一个能够自动生成PPT的神奇助手!🌟 什么是Kimi? 一款月之暗面科技有限公司开发的AI办公工具,帮助用户快速生成高质量的演示文稿。 无论你是职场人士、学生还是教师,Kimi都能够为你的办公文

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据,将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma

poj 1258 Agri-Net(最小生成树模板代码)

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码:效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n

poj 1287 Networking(prim or kruscal最小生成树)

题意给你点与点间距离,求最小生成树。 注意点是,两点之间可能有不同的路,输入的时候选择最小的,和之前有道最短路WA的题目类似。 prim代码: #include<stdio.h>const int MaxN = 51;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int P;int prim(){bool vis[MaxN];

poj 2349 Arctic Network uva 10369(prim or kruscal最小生成树)

题目很麻烦,因为不熟悉最小生成树的算法调试了好久。 感觉网上的题目解释都没说得很清楚,不适合新手。自己写一个。 题意:给你点的坐标,然后两点间可以有两种方式来通信:第一种是卫星通信,第二种是无线电通信。 卫星通信:任何两个有卫星频道的点间都可以直接建立连接,与点间的距离无关; 无线电通信:两个点之间的距离不能超过D,无线电收发器的功率越大,D越大,越昂贵。 计算无线电收发器D

hdu 1102 uva 10397(最小生成树prim)

hdu 1102: 题意: 给一个邻接矩阵,给一些村庄间已经修的路,问最小生成树。 解析: 把已经修的路的权值改为0,套个prim()。 注意prim 最外层循坏为n-1。 代码: #include <iostream>#include <cstdio>#include <cstdlib>#include <algorithm>#include <cstri

【生成模型系列(初级)】嵌入(Embedding)方程——自然语言处理的数学灵魂【通俗理解】

【通俗理解】嵌入(Embedding)方程——自然语言处理的数学灵魂 关键词提炼 #嵌入方程 #自然语言处理 #词向量 #机器学习 #神经网络 #向量空间模型 #Siri #Google翻译 #AlexNet 第一节:嵌入方程的类比与核心概念【尽可能通俗】 嵌入方程可以被看作是自然语言处理中的“翻译机”,它将文本中的单词或短语转换成计算机能够理解的数学形式,即向量。 正如翻译机将一种语言

poj 3723 kruscal,反边取最大生成树。

题意: 需要征募女兵N人,男兵M人。 每征募一个人需要花费10000美元,但是如果已经招募的人中有一些关系亲密的人,那么可以少花一些钱。 给出若干的男女之间的1~9999之间的亲密关系度,征募某个人的费用是10000 - (已经征募的人中和自己的亲密度的最大值)。 要求通过适当的招募顺序使得征募所有人的费用最小。 解析: 先设想无向图,在征募某个人a时,如果使用了a和b之间的关系

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能