基础知识回顾03

基础知识回顾03

包机制

• 为了更好的组织类，Java提供了包机制，用于区分类名的命名空间。

• 包语句的语法格式为：

  package pkg1[. pkg2[. pkg3...]];

• 一般利用公司域名倒置作为包名。 www.baidu.com com.baidu.www

• 为了能够使用某个包的成员，我需要在Java程序中明确导入该包。使用import可以使用此功能。

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

  *代表通配符，意思包括此包里的所有类成员

javaDoc

javaDoc生成文档

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

• 常见的tag

  tag	描述	例子
  @author	用于class和interface的声明中，表示作者	@author 作者
  @version	指定类的版本，代表版本号	@version info
  @since	指明需要最早使用的JDK版本
  @param	用于构造函数及函数的参数说明	@param 参数名 参数说明
  @return	返回值情况，表示函数的返回值	@return 函数返回值说明
  @throws	异常抛出情况,表示出方法可能抛出的异常	@throws RuntimeException 描述
  @exception	和@throws一样，官网推荐用@throws
  @see	链接目标，@see Tag只能顶格写	@see 其他类
  {@link}	和@see类似，但可以放在任意位置	{@link 其他类名}
  {@value}	显示常量的值，该常量必须是final属性
  {@code}	以代码字体显示文本而不将文本解释为HTML标签或嵌套的javadoc标签
  {docRoot}	文档的根路径

  块标签：只能放在主要描述部分后面的标签部分。 块标签的格式为：@tag。
  内联标记：可以放在主要描述中的任何位置或块标签的注释中。 内联标记用花括号标记：{@ tag}。

  代码中使用文本注释/**......*/即可

• ** jdk8在线帮助文档

使用命令行生成JavaDoc文档

点击index.html进入可以看到自动生成的文档

使用idea生成JavaDOC文件

ok之后去输出的路径位置里点击index.html进入可以看到自动生成的文档

规范性

• 写在类上面的Javadoc

  写在类上的文档标注一般分为三段：

  第一段：概要描述，通常用一句或一段话简要描述该类的作用，以英文句号作为结束

  第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束

  第三段：文档标注，用于标注作者、创建时间、参阅类等信息

• 写在方法上的Javadoc

  第一段：概要描述，通常用一句或一段话简要描述该方法的作用，以英文句号作为结束

  第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束

  第三段：文档标注，用于标注参数、返回值、异常、参阅等
  英文句号作为结束

  第二段：详细描述，通常用一段或者多段话来详细描述该方法的作用，一般每段话都以英文句号作为结束

  第三段：文档标注，用于标注参数、返回值、异常、参阅等