在Netbeans中，创建包级别的javadoc。

Question

在Netbeans中，创建包级别的javadoc。

3

好的。看起来有很多关于如何做到这一点的信息，但我在包描述的javadoc中没有得到这些信息。而且，我对如何确切地执行此操作感到有些困惑。

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

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

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

我可能有点傻，但是我真的不明白。能否有人给我提供具体信息或指引我去看适合新手的相关主题？

- Patricia

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- DwB · Accepted Answer

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

/* <--- 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;