栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java中的包机制,JavaDoc生成文档

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java中的包机制,JavaDoc生成文档

包机制

一般用公司域名倒置作为包名:如百度网址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文件,点开之后是我们自己写的类的帮助文档说明
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/1000270.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号