如何添加包级别注释或编辑 package-info.java？

Question

我正在尝试添加包级别注释，但我不知道如何做到这一点。示例值得赞赏。

Answer 1

此处文章摘要

在 package-info.java 中：

@PackageLevelAnnotation
package blammy; // package with a package level annotation.


import blammy.annotation.PackageLevelAnnotation;

在 PackageLevelAnnotation 中.java

package blammy.annotation;

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.PACKAGE)
public @interface PackageLevelAnnotation
{
  // stuff as required.
}

编辑：更多包级别信息。
以下是 Java 语言规范中包章节的链接： 包

Answer 2

在 Eclipse 中

由于 package-info.java 不是类的有效标识符，因此无法在 Eclipse 中将其创建为类。

我发现当你创建一个新包时，有一个复选框可以检查你是否需要 package-info.java。

要在现有包中创建 package-info.java 文件：

1. 右键单击​​要在其中创建 package-info.java 的包。
2. 选择新建->包。
3. 选中创建 package-info.java 复选框。
4. 单击“完成”。

Answer 3

package-info.java

package-info.java 是一个 Java 文件，可以添加到任何 Java 源代码包中。它的目的是为包级文档和包级注释提供一个家。

只需创建 package-info.java 文件即可。在文件中添加包声明。事实上，package-info.java 文件必须包含的唯一内容是包声明。

最小包信息文件示例：

package com.example.myapp.backend.data;

包级注释示例，@ParametersAreNonnullByDefault：

@ParametersAreNonnullByDefault
package com.example.myapp.backend.data;

import javax.annotation.ParametersAreNonnullByDefault;

有关详细信息，请参阅 Java 规范，位于 Java® 语言规范，第 7.4.1 节命名包。

Answer 4

打开资源管理器，转到 src/你的包文件夹。
右键单击->创建新的文本文件：将其命名为 package-info.java。

返回eclipse并编辑并添加所需的内容。