java - 在包级别创建 javadoc Netbeans

Question

好的。那里似乎有很多关于如何执行此操作的信息，但我没有在我的 javadoc 中获取有关包描述的信息。另外，我对如何执行此操作的确切过程有点(或很多)困惑。

我已经按照 this answer 中的规定创建了一个 package-info.java 类.

/*
 * Package description that I want to get added to my javadoc
 */
package com.pdl.myapp;

但是当我运行 generate javadocs 时，javadocs 中的包描述中没有任何内容。

然后我尝试使用包级注释，如 this answer 中所述但是对于究竟应该放什么来替换 //根据需要的东西感到非常困惑。

这是我的 package-info.java 类。请注意，已添加了 @PackageLevelAnnotation 注释。

/*
 * Package description that I want to get added to my javadoc
 */
@PackageLevelAnnotation
package com.pdl.myapp;

这是我的

package com.pdl.myapp;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 *
 * @author Miss Lucy
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.PACKAGE)
public @interface PackageLevelAnnotation {
    // stuff as required  <----- WHAT IS THIS?
    // How do I add my package description?
    // Package description that I want to get added to my javadoc
}

说我笨，但我就是不明白。谁能给我具体信息或指出这个傻瓜主题？

Answer 1

看来您使用了错误的注释样式。

/* <--- note one asterisk.
 * You are using this, this does not generate java docs.
 */

在您的 package-info.java 文件中，在包上方包含一个 java 文档注释。 例如:

 /** <--- note two asterisks.
  * This is my package description
  */
 package com.blam.kapow;