Java包机制及javadoc详解

 更新时间:2022年10月14日 10:39:19   作者:狗屎圈  
为了更好地组织类,Java提供了包机制,用于区别类名的命名空间,一般利用公司域名倒置作为包名,这篇文章主要介绍了Java包机制以及javadoc,需要的朋友可以参考下

包机制

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

package pkg1[. pkg2[. pkg3...]];

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

  • 例如 www.baidu.com
  • 包为 com.baidu.www
  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用"import"语句可完成此功能。
import package1[.package2...].(classname|*);
  • 导入的包中导入*(通配符)表示导入该包下面所有的东西

JavaDoc

  • javadoc命令是用来生成自己API文档的
  • 参数信息
    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param 参数名
    • @return 返回值情况
    • @throws 异常抛出情况
  • 在包名的下面做好版本注释等
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */

然后使用javadoc进行文档生成(cmd中),如果java文件中出现了中文,最好加上编码设定

javadoc -encoding UTF-8 -charset UTF-8 xxx.java

则会生成一系列文档

到此这篇关于Java包机制以及javadoc的文章就介绍到这了,更多相关Java包机制内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:

相关文章

  • 浅谈一下SpringBoot中的异步任务

    浅谈一下SpringBoot中的异步任务

    这篇文章主要介绍了浅谈一下SpringBoot中的异步任务,SpringBoot 中的异步任务主要是指在 SpringBoot 中使用异步线程完成处理任务,在 SpringBoot 中使用异步线程非常简单,只需要两个注解就可以搞定,需要的朋友可以参考下
    2023-10-10
  • mybatis-plus 如何配置逻辑删除

    mybatis-plus 如何配置逻辑删除

    这篇文章主要介绍了mybatis-plus 如何配置逻辑删除,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • Java设计模式:组合模式

    Java设计模式:组合模式

    这篇文章主要介绍了快速理解Java设计模式中的组合模式,具有一定参考价值,需要的朋友可以了解下,希望能够给你带来帮助
    2021-09-09
  • Java中的同步非阻塞IO模型详解

    Java中的同步非阻塞IO模型详解

    这篇文章主要介绍了Java中的同步非阻塞IO模型详解,同步非阻塞IO模型,我们能够知道,用户线程一直发送请求,内核一直都能都够返回 ,直到内核完成准备数据、数据拷贝的工作,并且返回成功的指示,在此过程中用户线程不是阻塞的状态,需要的朋友可以参考下
    2024-01-01
  • 全面解析@InsertProvider执行原理

    全面解析@InsertProvider执行原理

    这篇文章主要介绍了全面解析@InsertProvider执行原理,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • Spring MVC简介_动力节点Java学院整理

    Spring MVC简介_动力节点Java学院整理

    Spring MVC属于SpringFrameWork的后续产品,已经融合在Spring Web Flow里面。今天先从写一个Spring MVC的HelloWorld开始,让我们看看如何搭建起一个Spring mvc的环境并运行程序,感兴趣的朋友一起学习吧
    2017-08-08
  • Java入门教程--带包的类如何编译与运行

    Java入门教程--带包的类如何编译与运行

    我们一般都是通过IDE(如Eclipse、Intellij Idea,STS等)来开发,调试java项目。在不借助IDE的情况下,如何编译、运行Java程序。打包编译时,会自动创建包目录,不需要自己新建包名文件夹。
    2022-12-12
  • Springboot jar包远程调试详解

    Springboot jar包远程调试详解

    这篇文章主要为大家详细介绍了Springboot jar包远程调试,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-09-09
  • Springboot下RedisTemplate的两种序列化方式实例详解

    Springboot下RedisTemplate的两种序列化方式实例详解

    这篇文章主要介绍了Springboot下RedisTemplate的两种序列化方式,通过定义一个配置类,自定义RedisTemplate的序列化方式,结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-09-09
  • Spring的@Configuration使用与原理

    Spring的@Configuration使用与原理

    这篇文章主要介绍了Spring的@Configuration使用与原理,@Configuration用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,需要的朋友可以参考下
    2023-05-05

最新评论