学习Java Day3-02 (基础语法学完了!)

本文介绍了Java的包机制,包括包的声明、命名规则以及如何导入其他包的类。重点讲解了JavaDoc注解的使用,以及如何在终端中编译并生成API文档实例。
摘要由CSDN通过智能技术生成

包机制

  • 为了更好的组织类,Java提供包机制,用于区别类名的命名空间
  • 包语句的语法格式为:
package pkg1[. pkg2[. pkg3...]];
  • 一般利用公司域名倒置作为包名; 例如 com.baidu.www
    这里有个需要注意的是直接建立包中包需要有个IDEA的设置,把Compact Middle Packages的勾去掉
    在这里插入图片描述

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

package com.uky.operator;

//如果本页也就是该类下面可能需要引用别的类的内容,精准的可以直达
import com.uky.operator.Demo4;

但代码太多也不知道在哪,用通配符*

package com.uky.operator;

//代码太多也不知道在哪,用通配符*,这个会导入这个包下所有类
import com.uky.operator.*;

JavaDoc (语法结束,首尾呼应)

Day1的学习里面有注释,学习了单行注释 //
学习了多行段落注释 /* */
还有第三种注释类型就是文档注释,即JavaDoc

package com.uky.base;

/*
*@author uky
* @version 1.0
* @since 1.8
 */
public class Doc {

    String name;

    /*
    * @author uky
    * @param name
    * @return
    * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}
  • JavaDoc命令用来生成自己API文档的
  • 参数信息
  1. @author 作者名
  2. @version版本号
  3. @since指明需要最早使用的jdk版本
  4. @param参数名
  5. @return返回值情况
  6. @throws异常抛出情况

最后,练习一个作业,用终端命令编译一份Doc文档

  • 打开终端找到文件夹,记得用 ls cd 等就行了
u-ky@U-kydeMacBook-Air ~ % ls
Desktop		Downloads	Movies		Pictures
Documents	Library		Music		Public
u-ky@U-kydeMacBook-Air ~ % cd Documents
u-ky@U-kydeMacBook-Air study % cd Code
u-ky@U-kydeMacBook-Air Code % cd Hello
u-ky@U-kydeMacBook-Air Hello % cd src
u-ky@U-kydeMacBook-Air src % cd com
u-ky@U-kydeMacBook-Air com % cd uky
u-ky@U-kydeMacBook-Air uky % cd base
u-ky@U-kydeMacBook-Air base % javadoc -encoding UTF-8 -charset UTF-8 Doc.java 
//中间的encoding UTF-8 -charset UTF-8是为了有中文的情况下不显示乱码
正在加载源文件Doc.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_391
正在构建所有程序包和类的树...
正在生成./com/uky/base/Doc.html...
正在生成./com/uky/base/package-frame.html...
正在生成./com/uky/base/package-summary.html...
正在生成./com/uky/base/package-tree.html...
正在生成./constant-values.html...
正在构建所有程序包和类的索引...
正在生成./overview-tree.html...
正在生成./index-all.html...
正在生成./deprecated-list.html...
正在构建所有类的索引...
正在生成./allclasses-frame.html...
正在生成./allclasses-noframe.html...
正在生成./index.html...
正在生成./help-doc.html...
u-ky@U-kydeMacBook-Air base % 

可以看到已经有了很多编译html文件
在这里插入图片描述
打开index首页看看长啥样,虽然有些不懂,虽然只是帮助文档,但好歹是自己的帮助文档,好像是第一次看到自己生成的文件被网页打开,还是很期待的。
在这里插入图片描述
基础学完了,以后每天要用到的东西,有些东西现在记不住,但用的多了肯定不是什么难得

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值