包机制与JavaDoc生成api文档及IDEA中生成api文档相关

17.包机制

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

package pk1.pk2[.pk3[.pk4]];

• 一般利用公司域名倒置作为包名，例：www.baidu.com --> com.baidu.www, com.baidu.baike

18.JavaDoc

javadoc 标签

javadoc 工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

• 常用标签

  • @author 标识一个类的作者
  • @version 指定类的版本
  • @deprecated 指名一个过期的类或成员
  • @throws 抛出异常
  • @param 参数情况
  • @return 返回值

• JavaDoc可以帮助我们生成api文档

• Javase api在线文档中文版

  

• 步骤，在要生成api文档的包下边使用javadoc命令生成文档

javadoc -encoding UTF-8 -charset UTF-8 要生成文档的java文件

在IDEA中如何生成api文档

1. 选中要生成文档的模块，菜单栏找到Tools --> Generate JavaDoc

2. 设置输出的文件路径，和编码参数，点击ok

3. 点击查看生成的文档