首页 > 编程语言 >Day10-JavaDoc

Day10-JavaDoc

时间:2024-10-06 21:11:37浏览次数:6  
标签:UTF javadoc JavaDoc 源文件 文档 Day10 生成

Day10-JavaDoc

JavaDoc介绍

JavaDoc:

javadoc 命令是用来生成自己 API 文档的。

javadoc 是一个工具,它可以读取源代码中的文档注释,并将其转换为格式规范的 API 文档。javadoc 通过解析文档注释中的特定标记,如 @author、@version、@since、@param、@return、@throws 等,来提取关键信息,生成易于阅读和理解的文档。

参数信息:

  • @author:作者名。

  • @version:版本号。

    @since:指明需要最早使用的 jdk 版本。

    @param:参数名。

    @return:返回值情况。 -

    @throws:异常抛出情况。

JavaDoc生成

package com.liu.www.basic;

/**
 * @author liu
 * @version 1.0
 * @since
 */

public class Doc {

    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }

1.命令行生成

D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

这是一个在命令提示符或终端中执行的命令,用于为特定的 Java 源文件生成文档。 具体解释如下: - “D:\IDEA\example\JavaSE\Basic Grammar\src\com\liu\www\basic>”是当前命令执行的路径,表示命令提示符或终端当前所在的目录是这个路径。

  • “javadoc”是用于生成 Java API 文档的工具。

  • “-encoding UTF-8”指定输入源文件(即 Java 源文件)的编码为 UTF-8,确保能够正确处理可能包含非 ASCII 字符的源文件内容。

    “-charset UTF-8”通常指定生成的文档的字符编码为 UTF-8,保证生成的文档中的字符能正确显示和被不同的系统和工具处理。

    • “Doc.java”是要生成文档的 Java 源文件的名称。这个命令会读取“Doc.java”文件中的文档注释,并生成相应的 API 文档。

总结:

javadoc 参数 Java文件

2.IDEA里面生成

(暂时不写)

标签:UTF,javadoc,JavaDoc,源文件,文档,Day10,生成
From: https://www.cnblogs.com/xiaokunzhong/p/18449414

相关文章

  • Day10-域名
    Day10-域名域名是由一串用点分隔的字符组成的互联网上某一台计算机或计算机组的名称,用于在数据传输时标识计算机的电子方位。例如“www.baidu.com”就是一个域名。它主要由几个部分组成:顶级域名(Top-levelDomain,TLD):如“.com”“.net”“.org”等,代表不同的域名类型或用途。......
  • Day10-包机制
    Day10-包机制包机制Java为更好地组织类而提供的机制,用于区别类名的命名空间。包相当于文件夹包语句的语法格式为:(定义包)packagepkg1[.pkg2[.pkg3...]];一般利用公司域名倒置作为包名。为了能够使用某一个包的成员,需要在Java程序中明确导入该包,使用“import”语句可完......
  • 【21 ZR联赛集训 day10】身经百战
    【21ZR联赛集训day10】身经百战显然每个怪物是独立的。我们考虑对操作建带权边,答案就是求最短路。但是点数太多,于是我们可以对怪物血量和所有\(a_i,b_i\)离散化一下,因为我们只需要考虑这些点,注意\(1\)也要离散化,因为我们需要考虑\(1\)。一个小优化,如果\(a_i>b_i\)且......
  • 【21 ZR联赛集训 day10】不知道高到哪里去了
    【21ZR联赛集训day10】不知道高到哪里去了二分答案。设敌人的速度是\(1\),二分我的速度\(v\),我可以从\(C\)走到\(T\)当对于每个我到达的点\(u\),敌人无法比我先到达,即敌人到达\(u\)最短用时比我大。先求敌人到每个结点的最短路,然后对于二分的一个\(v\),从\(C\)开始搜......
  • 【21 ZR联赛集训 day10】跑得比谁都快
    【21ZR联赛集训day10】跑得比谁都快\(O(nq)\)做法显然,不讲。如果我们把所有红绿灯的位置\(mod(g+r)\),放到数据结构里,就可以\(O(\logn)\)的时间内找到第一个红灯的位置。然后我们预处理每个红绿灯红灯结束的时刻开始,走到终点要用的时间\(f_i\),DP倒序求解。对于每个询......
  • 【20联赛集训day10】玩游戏
    【20联赛集训day10】玩游戏给一个长度为\(n\)的序列,\(|a_i|\le10^{13}\)。给出一个\(k\)问从\(k\)出发不断向两端拓展,满足任何时刻的区间和\(\le0\),问能否拓展到区间\((1,n]\)。考虑贪心,分别维护\(k\)左边和右边的区间,维护一个指针。每次贪心地向一边走,走到能走到......
  • 【20zr提高组十连测day10】心
    【20zr提高组十连测day10】心首先不同的操作序列一定在某个时刻使数组内容不同,因此我们只需要统计合法的操作序列数量。一个合法的最终数组形如若干个\(1,M\),而且\(1,M\)之间可能有若干个\(x\),长度为\(n+1\)。造成这个数组的操作序列必须满足所有操作\(1,M\)按顺序排列,......
  • 【20zr提高组十连测day10】信
    【20zr提高组十连测day10】信给定\(n,m\),\(n,m\le10^5\),给定分别长度为\(n-1,m,n,m-1\)的单调不减的序列\(A,B,C,D\),然后形如该图建边:考虑到序列是递增的,对于除最左上角以外的每个点,每个点一定要选和自己相连的一条边才能形成一棵树。那么选择左边或上边一定是更优的,而且......
  • 【20联赛集训day10】排列
    【20联赛集训day10】排列一个长度为\(n\)的排列,每次操作删除所有存在相邻的数字比它更大的数字,问执行\(k\)次操作后剩下恰好一个数的排列方案数。首先因为每次删除至少删一半的数字,所以最多删\(\log\)次。对于一个排列,我们可以发现把序列按最大值劈开,左右两边互不干扰,成......
  • 【20省选十联测day10】Easy Win
    【20省选十联测day10】EasyWin题意原题链接有\(n\)堆石子,\(n\le5\times10^5\),每堆石子有\(a_i\)个,\(a_i\len\)。Alice和Bob每次可以从,某一堆取至少\(1\)颗、至多\(x\)颗石子,不能取的失败。Alice先手,问对于所有\(1\lex\len\),问谁胜利。思路对于一堆石子,计......