在包级别 Netbeans 创建 javadoc

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 中描述的包级别注释，但对于替换 // stuff as required. 的确切内容感到非常困惑

这是我的 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 doc 注释。 例如：

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