java学习day03_包机制&javadoc

时间:2020-9-15 作者:admin

java学习day03_包机制&javadoc

包机制

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

  • 包语句的语法格式为:

    package pkg1[.pkg2[.pkg3...]];
    
  • 一般利用公司域名倒置作为包名;

  • 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包,使用import语句可以完成此功能

    import package1[.package2...].(classname*);
    

    注:如果嫌导入包中的某个类时,可以使用通配符*

javadoc

  • JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档
package Base;

/**
 * @author zixiao
 * @version 1.0
 * @since  1.8
 */
public class Doc {
    String name;

    /**
     * @author zixiao
     * @param name
     * @return name
     * @throws Exception
     */
    public  String test(String name) throws Exception{
        return name;
    }
  
}
  • 通过命令行生成javadoc文档:
    ->打开cmd->javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  • 通过使用IDEA生成javadoc文档:
    1:java学习day03_包机制&javadoc
    2:
    java学习day03_包机制&javadoc
  1. 文档的输出路径
  2. Locale选择地区,这个决定了文档的语言,中文就是:zh_CN
  3. 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

3:java学习day03_包机制&javadoc
4:看看生成的javadoc文档的效果
java学习day03_包机制&javadoc

声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。