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

lin*_*boy 40 java annotations javadoc package

我正在尝试添加包级别注释,但我不知道如何做到这一点.赞赏的例子.

jav*_*der 38

在日食中

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

我发现当你创建一个新包时,有一个复选框来检查你是否想要一个package-info.java.

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

  1. 右键单击要包含package-info.java的包.
  2. 选择New-> Package.
  3. 选中Create package-info.java复选框.
  4. 单击"完成".

  • 这在我的Eclipse版本(3.7.2)中不起作用 - 此解决方案需要哪个版本? (2认同)
  • 要将此类文件添加到现有包中,请在项目浏览器→新建→其他→文件中右键单击该包,然后手动将其命名为package-info.java.我一直忘记究竟要调用文件的内容以及要添加的注释,所以我喜欢阅读更优雅的方式. (2认同)

DwB*_*DwB 29

从文章摘要这里

在package-info.java中:

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


import blammy.annotation.PackageLevelAnnotation;
Run Code Online (Sandbox Code Playgroud)

在PackageLevelAnnotation.java中

package blammy.annotation;

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.PACKAGE)
public @interface PackageLevelAnnotation
{
  // stuff as required.
}
Run Code Online (Sandbox Code Playgroud)

编辑:更多包级别信息.这是Java语言规范包中的包章节的链接


Kar*_*ski 5

package-info.java

\n\n

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

\n\n

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

\n\n

最小包信息文件的示例:

\n\n
package com.example.myapp.backend.data;\n
Run Code Online (Sandbox Code Playgroud)\n\n

包级注释的示例@ParametersAreNonnullByDefault

\n\n
@ParametersAreNonnullByDefault\npackage com.example.myapp.backend.data;\n\nimport javax.annotation.ParametersAreNonnullByDefault;\n
Run Code Online (Sandbox Code Playgroud)\n\n

有关更多信息,请参阅Java\xc2\xae 语言规范中的Java 规范,第 7.4.1命名包部分。

\n