当前位置: 首页 > 网络应用技术

开源项目经常查看package-info.java文件。什么用?

时间:2023-03-08 20:34:53 网络应用技术

  Pacakge-info.java是一个可以添加到任何Java源软件包的Java文件。Pacakge-info.java的目标是提供包装的文档描述或等级注释。

  在pacakge-info.java文件中,包含包装声明所需的唯一内容,例如:

  在Java 5之前,包装的文档是包装。用于生成Javadoc。

  在想法中,选择工具/生成Javadoc ...菜单项,如图所示:

  在生成的Javadoc窗口中输入相关设置。

  步骤1:选择Javadoc文档的范围。在下图中,我们可以选择模块模块。

  步骤2:输出目录最好创建一个新的文件夹,该文件夹更有条理和整洁。

  步骤3:语言环境设置,确定文档的语言,简化中文是zh_cn,传统(台湾)ZH_TW,传统(香港)ZH-HK,英语(香港)En-hk,英语(美国)En-us,,英语(美国)和英语(美国),英语(美国),英语(英国)en-gb,英语(全球)en-ww。

  设置后,单击[OK]按钮生成DOC文档。查看输出目录,然后打开index.html以读取生成的文档。

  查看类文档,如图所示:

  软件包-INFO文件不能随便创建,它将报告“这不是Value Java合格名称”错误。班级名称无效。未列出中范围行,那么如何创建此文件?

  您可以创建一个普通文件,如图所示,该文件被命名为“ package-info.java..java”,或更直接的方法是从其他项目中复制一个。

  如果您想在软件包中使用相应的变量并且不需要其他软件包,则可以将变量放在package-info.java下,以实现分包自使用的概念。

  在包装中的类别调用中,示例代码如下:

  袋子外的任何班级包装量都会引起错误。

  使用Javadoc时,通过在package-info.java上添加注释来添加注释以生成对Javadoc相应软件包的注释。

  生成相应的Javadoc文档,如图所示: