码迷,mamicode.com
首页 > 编程语言 > 详细

Java基础05:包机制、JavaDoc生成文档

时间:2020-12-28 11:26:07      阅读:0      评论:0      收藏:0      [点我收藏+]

标签:charset   jdk   pac   href   set   tle   格式   输出   get   

一、包机制

  • 为了更好的组织类,Java提供了包机制,用于区别类名的命名空间。(本质是文件夹)
  • 包语句的语法格式为:
package pkg1[. pkg2[. pkg3...]];
  • 一般利用公司玉门倒置作为包名;www.baidu.com--com.baidu.www
  • 为了能够使用一个包的成员,我们需要再Java程序中导入该包,使用“import”语句可完成此功能
import pkg1[.pkg2...].(classname|*);
  • 尽量不要让包里面的名字重复

二、JavaDoc生成文档

  • 参数信息
    • @author 作者名
    • @version 版本号
    • @since 指明需要最早使用的jdk版本
    • @param 参数名
    • @return 返回值情况
    • @throws 异常抛出情况
  • javadoc 命令是用来生成自己API文档的
package com.kuang.base;
/**
 * @author kuangshen
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author kuagnshen
     * @param name
     * @return
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return  name;
    }
    //通过命令行  javadoc 参数 Java文件
    //作业:学会查找使用IDEA生成JavaDoc文档; 面向百度编程
    //基础部分的一切知识,几乎每天都会使用到,需要熟练掌握
}
  1. 进入到Doc.java所在目录,输入命令,
    技术图片
  2. 进入到对应的文件夹下,会生成许多.html文件,打开index.html,会打开跟JDK8官方帮助文档一样的帮助文档
    技术图片
  • 使用IDEA生成JavaDoc文档
  1. 点击Tools设置,选择Generate JavaDoc...
    技术图片
  2. 打开设置
    技术图片
    1). 选择是整个项目还是模块还是单个文件
    2). 文档输出路径
    3). Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
    4). 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api
  3. 点击【OK】,控制台输入如下:
    技术图片
  4. 在对应的目录下,找到index.html,查看生成的帮助文档

Java基础05:包机制、JavaDoc生成文档

标签:charset   jdk   pac   href   set   tle   格式   输出   get   

原文地址:https://www.cnblogs.com/xiongxzc/p/14171233.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!