|

楼主 |
发表于 2017-7-5 15:41:41
|
显示全部楼层
本帖最后由 回忆一遥远 于 2017-8-16 07:39 编辑
名字可见性
Java 设计者希望反过来使用自己的 Internet 域名来确保类库的名字时独一无二的。
在 Java 1.0 和 Java 1.1 中,扩展名 com 、 edu 、 org 、 net 等约定为大写形式。在 Java 2 之后整个包名都改成小写了。
使用构建
通过 import 指示编译器导入一个包(类库)。
java.lang 类库自动被导入每一个 Java 文件中。
Java 的注释和嵌入式文档
可以使用类似 C++ 中的段注释
/*
......
*/
也可以使用类似 C++ 中的单行注释
// ...
Javadoc ——注释文档的提取生成工具
javadoc 输出的是一个 HTML 文件,可以使用 Web 浏览器查看。Javadoc 命令只能在 "/**" 注释中出现,并结束于“*/”。
使用 Javadoc 的方式有两种:嵌入式 HTML,会使用“文档标签”。
独立文档标签是一些以“@”字符开头的命令,且要置于注释的最前面。“行内文档标签”可以出现在 Javadoc 注释中任何位置,它们也以“@”开头,但是要括在花括号内。
共有三种类型的注释文档,分别对应于注释位置后面的三种元素:类、域和方法。
例如:
/** 类的注释*/
public class Doc{
/**域的注释*/
public int i;
/**方法的注释*/
public void f(){}
}
Javadoc 只能为 public (公共)和 protected(受保护)成员进行文档注释。private (私有)和包内可访问成员的注释会被忽略掉。
部分文档的 Javadoc 标签
1. @see: 引用其他类
@see标签可以引用其他类的文档。Javadoc 会在其生成的 HTML 文件中,通过 @see标签链接到其他文档。Javadoc 不会检查所提供的超链接是否有效。
2.{@link package.class#member label}
该标签与 @see 非常相似,它用于行内,并且用 "label" 作为超链接文本而不用 "See Also"。
3.{@docRoot}
该标签产生到文档根目录的相对路径,用于文档树页面的显示超链接。
4.{@inheritDoc}
该标签当前这个类的最直接的基类中继承相关文档到当前的文档注释中。
5.@version
如果 Javadoc 命令行使用了 “-version”标记,那么就可以从生成的 HTML 中提取版本信息。
用法: @version 版本信息
6.@author
如果 Javadoc 命令行使用了 “-author”标记,那么就可以从生成的 HTML 中提取作者信息。
用法: @author 作者信息
7.@since
该标签允许你指定程序代码最早使用的版本。
8.@param
用法:@param parameter-name description
parameter-name 是方法参数列表中的标识符
description 是可延续数行的文本,终止于新文档标签出现之前。
9.@return
该标签用于方法文档
用法:@return description
"description" 用来描述返回值的意义,可以延续数行。
10.@throws :”异常“
用法:@throws fully-qualified-class-name description
fully-qualified-class-name 给出一个异常类的无歧义的名字,该异常类在别处定义。
description 告诉你为什么此特殊类型的异常会在方法调用中出现。
11.@deprecated
指出一些旧特性已经由改进的新特性所取代,建议用户不要使用这些旧特性,因为不久的将来他们很可能会被删除。
Java SE 5 之后,@deprecated 标签已经被 @Deprecated 注解所替代。
|
|