首页 > 编程语言 >Java基础语法重点06(java Doc生成文档)

Java基础语法重点06(java Doc生成文档)

时间:2022-09-19 21:35:02浏览次数:99  
标签:06 java name Doc 文档 Java String

JDK文档

(jdk文档中提供了java中的各种技术的详细资料,以及jdk中提供的各种类的帮助说明)

参数信息

  • @ author (作者名)
  • @ version (版本号)
  • @ since (指明需要最早使用的jdk版本)
  • @ param (参数名)
  • @ return (返回值情况)
  • @ throws (异常抛出情况)
/**
 *@author  zhangyi  //加在类上面,即为类注释
 *@version 1.0
 *@since   1.8 
*/
public class Doc{
    String name;//属性

/**
 *@param name      //加在方法上面,即为方法注释
 *@return 
 *@throws Expection
*/                              //抛出异常
public String test(String name) throws Expection{
    return name;
  }
}

扩展:

  • 找到类的地址

  • 在命令行打开cmd

  • 输入:javadoc -encoding UTF-8 -charset UTF-8 Doc.java
    image-20201212190410230

  • 会看见文件夹下面多了一堆东西,其中有index.html(首页),

​ 点开
image-20201212190410230

  • 会看见其生成的文档信息,非常详细
    image-20201212190410230

每日分享:

生活从来都是泥沙俱下,鲜花与荆棘并存

标签:06,java,name,Doc,文档,Java,String
From: https://www.cnblogs.com/zhang11/p/16709130.html

相关文章

  • docker run的--rm选项详解
    在Docker容器退出时,默认容器内部的文件系统仍然被保留,以方便调试并保留用户数据。因此,可以通过--rm命令,让容器在退出时,自动清除挂载的卷,以便清除数据:另外,当容器退出时,通过......
  • docker删除所有none镜像或停止的容器
    在docker反复build后,会存留很多none镜像,下面命令一键删除所有none镜像(docker清理)dockerrmi`dockerimages|grep'<none>'|awk'{print$3}'`dockerrmi`do......
  • java: Facade Patterns
     /***版权所有2022涂聚文有限公司*许可信息查看:*描述:*门面模式FacadePatterns*历史版本:JDK14.02*2022-09-12创建者geovindu*2022-09-12......
  • JavaWeb 4 事务
           ......
  • Docker容器里面的时间跟宿主机对不上
    Docker基本上都采用UTC时间,默认时区为零时区。在Linux系统中,控制时区和时间的主要是两个地方:/etc/timezone主要代表当前时区设置,一般链接指向/usr/share/zoneinfo......
  • 使用Supervisord管理Docker内的服务,容器启动就退出
    问题:启动后直接退出command:"/usr/bin/supervisord-c/etc/supervisord.conf"解决方法:将supervisor配置的nodaemon=false修改为nodaemon=true,使supervisor......
  • 第二次Java课堂随笔(静态static的内容)
    老师的课件里面提到了Java中的静态导入内容,那么什么是静态导入呢?于是我在网上查了这个有关内容,百度给出的解释是这样的:Java静态导入实际上就是通过给导入包名中添加一个sta......
  • Java基础2——流程控制
    Scanner通过scanner获取用户的输入,实现交互。importjava.util.Scanner;publicclassdemo{publicstaticvoidmain(String[]args){Scannners=n......
  • Java基础03——方法
    方法的定义与调用方法的定义类似函数,用于完成特定功能的代码片段格式:修饰符返回值类型方法名(参数类型参数名){​ 方法体;​ return返回值;}参数类型:实参(实......
  • Docker容器启动失败查看日志
    1.dockerps-a查看容器进程CONTAINERIDIMAGECOMMANDCREATEDSTATUSPORTSNAMESc5fe8083e7e......