如何理解Java中的包机制,如何有效使用JavaDoc生成文档

createh53个月前 (02-07)技术教程18

包机制

一般用公司域名倒置作为包名:如百度网址www.baidu.com,包命名为com.baidu.www(com.yang)

包必须在类的最上面,导入包使用语句import package 包名.(是通配符代表包名下所有内容)

搜索:百度搜阿里巴巴开发手册学习Java基础

JavaDoc

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

jdk帮助文档(浏览器搜索)

//参数信息
@author 作者名
    @version 版本号
    @since 需要最早使用的jdk版本
    @param 参数名
    @return 返回值情况
    @throws  异常抛出情况

选择类右键选Show in explorer可进入类存储地址,在类地址前进入cmd,并输入javadoc -encoding UTF-8 -charset UTF-8 类名.java,执行后会在类存储地址生成index.html文件,点开之后是我们自己写的类的帮助文档说明

idea生成Javadoc文档

  1. 首先新建一个文件夹,用来专门存放Javadoc文档
  2. 打开idea选择要生成文档的代码
  3. 选择之后就看idea的顶部有一个Tools的菜单,选择Generate JavaDoc这个选项
  4. 然后会弹出一个界面,然后在Output directory 输入框后面的按钮点击进去选择刚才创建的文件夹
  5. 然后在下面的locale框中输入zh_CN,这个代表的就是中文,输完之后在locale下面的框中输入-encoding utf-8 -charset utf-8
  6. 最后点击ok,等待文件生成完毕之后,执行后会在JavaDoc文件夹生成index.html文件,点开之后是我们自己写的类的帮助文档说明

相关文章

java超简单系列课程——使用记事本写一个java程序

下一个知识点来讲如何使用记事本来开发一个java程序。先分为几个步骤。·第一个步骤先是编码过程。·第二个步骤要经过编译。编译就是把写的java代码,程序员能看懂的java代码翻译成电脑系统能够看懂的j...

java如何高效地读取一个超大文件?(四种方式分析对比)

前言我最近在优化我的PDF转word的开源小工具,有时候会遇到一个问题,就是如果我的PDF文件比较大,几百兆,如何更快更节省内存的读取它。于是我分析对比了四种常见的读取文件的方式,并使用javaVis...

Mybatis配置文件XML全貌详解,再不懂我也没招了

一、为什么要使用配置文件试想,如果没有配置文件,我们的应用程序将只能沿着固定的姿态运行,几乎不能做任何动态的调整,那么这不是一套完美的设计,因为我们希望拥有更宽更灵活的操作空间和更多的兼容度,同时也能...

Java堆栈文件生成和分析_java 堆栈

生成:jmap -dump:live,format=b,file=c:\heap.hprof 分析: jvisualvmHeapDump敏感信息提取工具 https://github.com/whwl...

2025年Java开发者必读:编写文档的9种姿势

在2025年,Java代码的文档化对于保持项目的可维护性和减少开发团队之间的摩擦至关重要。随着代码库复杂性的增加,文档化确保了知识的共享、新成员的快速入职以及错误的减少。为什么Java代码文档化重要没...