首页 > 编程语言 >javadoc

javadoc

时间:2024-07-29 19:43:18浏览次数:11  
标签:return String cmd javadoc 生成 name

  • javadoc命令是用来生成自己API文档的
  • 参数信息
    @author 作者名
    @version 版本号
    @since 指明需要最早使用的jdk版本
    @param 参数名
    @return 返回值情况
    @throws 异常抛出情况
package com.studen.base;

/**
 * @author shudou
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;//属性

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

目前我了解到两种生成方法:通过命令行生成和通过IDEA生成。
1.通过命令行生成:
输入上述代码后,点击项目“Doc”——>“Open In”——>"Explorer"——>使用cmd :快捷进入命令提示符——>"javadoc -encoding UTF-8 -charset UTF-8 Doc.java"——>执行成功后,在文件夹中会生成一些东西——>查看“index.html”(设计网页的),即可看到所生成的文档页面
cmd(哪怕有警告也会继续生成、构建):

最后一步就能查看到下图:

其中,类下方的方法概要下的方法详细资料便是编写的方法:

值得注意:在cmd操作时最容易出现问题,写上篇便是如此。说实话,最后我也不知道咋回事自己就好了,不过以上步骤是正确的。
*点击“Explorer”后可以在导航栏去D:换cmd :,起初我没有加空格出现了没有跳转链接的应用,让自己下载。后来试着加了空格,居然跳转成功了。

  • 我出现的问题是“不是内部或外部命令”,环境配置是完全正常的,而当我重新创建项目后问题就消失了,所以我猜测可能在上次编写过程中,中英混合使用导致识别不出等

标签:return,String,cmd,javadoc,生成,name
From: https://www.cnblogs.com/205445xcvbn/p/18330856

相关文章

  • Java基础12:JavaDoc生成文档
    1.简介JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在IntellijIdea中如何将代码中的注释生成HTML文档。JavaDoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代......
  • 语法2-运算符、包机制、JavaDoc
    语法运算符运算符具有优先级-网上查(一般使用括号保证)/-除,%-取余符号-21/10二十一除十取余数,幂运算使用工具类表示Math.pow(2,3)-2的3次方++自加,--自减inta=3;intb=a++;//输出a=4,b=3intb=++a;//输出a=4,b=4==-等于,!=-instanceof-不等于逻辑运算符-与或非-&......
  • 如何使用javadoc?为什么需要这个源代码文档工具
    目录一、什么是javadoc二、javadoc为什么会找不到路径三、如何解决javadoc一直找不到路径的问题一、什么是javadocJavadoc是一种用于生成Java源代码文档的工具,它可以帮助开发者生成易于阅读和理解的文档。Javadoc通过解析Java源代码中的注释,提取其中的文档信息,然后......
  • JavaDoc生成文档
    javaDoc命令是用来生成自己API文档的参数信息:@auchor:作者名@version:版本号@since:指明需要最早使用的jdk版本@param:参数名@return:返回值情况@throws:异常抛出情况//主要生成的参数如:/***@author林伟填*@version1.0*@since1.8*/publiccla......
  • 【JavaParser笔记02】JavaParser解析Java源代码中的类字段信息(javadoc注释、字段​​
    这篇文章,主要介绍如何使用JavaParser解析Java源代码中的类字段信息(javadoc注释、字段名称)。目录一、JavaParser依赖库1.1、引入依赖1.2、获取类成员信息(1)案例代码<......
  • 包机制、JavaDoc
    包机制*代表导入这个包下所有的类!JavaDocJava的api帮助文档:https://docs.oracle.com/javase/8/docs/api/index.html/***@authorxqstudy*@version1.0*@since3.28*/publicclassDoc{Stringname;/****@paramname*@retur......
  • JDK tools-javadoc
    JDKtools-javadocJDK工具包-javadoc,从java源文件生成API文档的HTML页面javadoc工具解析一组java源文件中的声明和文档注释,并生成响应的HTML页面,这些页面描述(默认情况下)公共和保护属性的类、接口、构造函数、方法、字段。你可以使用javadoc工具为一组源文件生成API文档。......
  • 学java13javaDoc生成文档
    找到类的地址,进入类所在文件夹,在导航栏中最前面添加“CMD(空格)”后回车javadoc-encodingUTF-8-charsetUTF-8文件名.java通过idea生成:tools/生成javadoc/第一步:选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件。第二步:输出目录最好新建一个文件......
  • Java基础12:JavaDoc生成文档
    JavaDoc1.javadoc命令是用来生成自己API文档的2.参数信息2.1@author作者名2.2@version版本号2.3@since指明需要最早使用的jdk版本2.4@param参数名2.5@return返回值情况2.6@throws异常抛出情况 ......
  • 包机制和JavaDoc
    包机制为了更好地组织类,Java提供包机制,用于区别类名的命名空间。包语句的语法格式为:packagepkg1[.pkg2[.pkg3...]]一般利用公司域名倒置作为包名;//com.hongyi.xxx为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用“import”语句可完成此功能。impor......