JavaDoc

简介: JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中 参数信息 @author 作者名 @version 版本号 @since 指明需要最早使用的jdk版本 @param 参数名 @return 返回值情况 @throws 异常抛出情况 package com.wyd.base

JavaDoc


  • JavaDoc命令是用来生成自己API文档的,将写好的程序放在生成的文档中


  • 参数信息


  • @author 作者名


  • @version 版本号


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


  • @param 参数名


  • @return 返回值情况


  • @throws 异常抛出情况



package com.wyd.base;
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}


  • 打开所在文件夹


  • 微信图片_20220425162804.png


  • 在CMD中使用JavaDoc生成文档,javadoc -encoding UTF-8 -charset UTF-8 Doc.java


  • 微信图片_20220425162810.png



  • 生成文档的链接


  • 微信图片_20220425162817.png
相关文章
|
开发者 Windows Python
Udp 发送数据 | 学习笔记
快速学习 Udp 发送数据
Udp 发送数据 | 学习笔记
突然yml文件不显示绿叶子问题
记一次解决突然yml文件不显示绿叶子问题,原来好好的,今天打开突然就坏了,奇了怪了。。。
473 0
|
关系型数据库 数据库 PostgreSQL
postgresql :permission denied to create database
postgresql :permission denied to create database
1567 0
|
SQL Java 关系型数据库
|
安全 API 持续交付
阿里云云效产品使用问题之如何从流水线访问内网平台的HTTP接口
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。
|
关系型数据库 分布式数据库 数据库
沉浸式学习PostgreSQL|PolarDB 4: 跨境电商场景, 快速判断商标|品牌侵权
很多业务场景中需要判断商标侵权, 避免纠纷. 例如 电商的商品文字描述、图片描述中可能有侵权内容. 特别是跨境电商, 在一些国家侵权查处非常严厉. 注册公司名、产品名时可能侵权. 在写文章时, 文章的文字内容、视频内容、图片内容中的描述可能侵权. 例如postgresql是个商标, 如果你使用posthellogresql、postgresqlabc也可能算侵权. 以跨境电商为力, 为了避免侵权, 在发布内容时需要商品描述中出现的品牌名、产品名等是否与已有的商标库有相似. 对于跨境电商场景, 由于店铺和用户众多, 商品的修改、发布是比较高频的操作, 所以需要实现高性能的字符串相似匹配功能.
463 0
|
消息中间件 存储 负载均衡
中间件消息队列与发布/订阅模型
【7月更文挑战第15天】
558 6
|
人工智能 运维 安全
阿里云容器服务ACK:高效管理云上应用的容器化解决方案
阿里云容器服务ACK(Alibaba Cloud Container Service for Kubernetes)为开发者提供了一套全面的容器化管理解决方案,旨在简化云上应用的部署、运维和管理。本文将深入探讨ACK的功能、优势及应用场景,为开发者展现容器化技术在云环境下的强大能力。
1181 0
|
机器学习/深度学习 PyTorch 算法框架/工具
机器学习框架简介
【6月更文挑战第26天】机器学习框架简介。
348 5
|
数据采集 编译器 Linux
curl使用小记(一)
curl使用小记(一)
359 0