首页 > 编程语言 >包机制和JavaDoc

包机制和JavaDoc

时间:2023-02-07 16:12:49浏览次数:47  
标签:return String author javadoc JavaDoc 机制 name

包机制和JavaDoc

包机制

  • 为了更好地组织类,Java提供了包 机制,用于区别类名的命名空间。

  • 包本质就是一个文件夹。

  • 一般利用公司域名倒置作为包名。

  • 定义包用package,导入包用import。

  • import com.liu.base.*;    //导入这个包下所有的类
    

JavaDoc

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

参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
package com.liu.base;
/**
 * @author  liuwenwen
 * @version 1.0
 * @since  1.8
 */
public class Doc {
    String name;   //属性

    /**
     * @author  liuwenwen
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{      //方法
        return name;
    }
}

命令行javadoc -encoding UTF-8 -charset UTF-8 Doc.java生成javadoc文档

标签:return,String,author,javadoc,JavaDoc,机制,name
From: https://www.cnblogs.com/lww888/p/17098815.html

相关文章

  • 通过mongo-driver使用说明 GO 包管理机制
    本篇记录通过GO语言操作mongodb,实现的流程包括:初始化项目工程容器方式安装mongo调试运行和编译运行go使用mongo的代码如下,go操作mongo的SDK是mongo-driver,一个第三......
  • RPC框架的健康检测机制
    服务发现的作用:实时感知集群IP的变化,实现接口跟服务集群节点IP的映射。超大规模集群更要考虑最终一致性。“推拉结合,以拉为准”。1健康检测因为有了集群,所以每次发请求前,RP......
  • 包机制
    包机制语法格式:package文件夹1[.文件夹2[.文件夹3...]];packagetest.operator;一般使用公司域名倒置作为包名,如:com.baidu.www导入包:import包名;//导入test.operat......
  • JavaDoc生成文档
    JavaDoc生成文档1、单击Tools-GenerateJavaDoc2、选择要生成文档的类或包,存放路径,设置字符格式,单击OK3、进入存放JavaDoc文件夹,点击index.html即可看生成的JavaDoc......
  • Java序列化机制要序列化那些内容
    在javaeye上搜到一篇robbin关于java序列化的回复,我觉得其中的例子很有说服力,转过来和大家分享。关于更多java序列化的问题可以参见JAVA系列之对象的......
  • 数据库并发控制机制的理解
    隔离级别相当于数据库实现的一套现有的机制,我们直接可以复用;但对于特殊需求,我们可以自己使用锁机制来实现,其实我们自己就可以使用锁机制,实现一套隔离级别;锁机制只是隔......
  • JVM垃圾回收机制,万字详解
    JVM垃圾回收机制jvm的基本组成虚拟机的组成所谓java能实现跨平台,是因为在不同平台上运行不同的虚拟机决定的,因此java文件的执行不直接在操作系统上执行,而是通过jvm虚拟机执......
  • 【Java AWT 图形界面编程】事件处理机制 ③ ( AWT 中常见的事件和事件监听器 | 低级事
    文章目录​​一、AWT中常见的事件​​​​1、低级事件​​​​2、高级事件​​​​二、AWT中常见的事件监听器​​一、AWT中常见的事件AWT中事件分为两大类,低级事件......
  • 浅析MySql中的MVCC机制
    前言本文将分析mvcc的机制和工作原理并举例说明。话不多说,直入主题MVCC机制是什么MVCC,英文全称MultiversionConcurrencyControl,多版本并发控制。简单理解,就是相当于给......
  • 6.2RLE算法的机制
    对存储着AAAAAABBCDDEEEEEF这17个半角字符的文件(文本文件)进行压缩。由于半角字母中,1个字符是作为1个字节的数据被保存在文件中的,因此上述文件的大小就是17字节,只要文件小......