在包级别Netbeans上创建javadoc

Question

行。似乎有很多关于如何做到这一点的信息，但我没有在我的javadoc中获取包描述的信息。另外，我有点（或很多）对如何做到这一点的确切程序感到困惑。

我已经创建了http://www.example.com/admin/index.html中指定的package-info.java类。

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

但是当我运行生成javadoc时，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;