java - javadoc 中未提及的弃用方法

标签 java javadoc

我有 2 个类(class)。第一个包含已弃用的方法。第二个类实例化第一个类并使用其已弃用的方法。

编译器确实会显示警告,但是:

问题:为什么在运行 javadoc Test.java 后生成的 Java 文档中没有列出已弃用的方法?

代码如下:

import java.lang.annotation.*;
class Tester{
   private int a = 1;
   /**
   * @deprecated
   * This is deprecated because I do not like it
   */
   @Deprecated
   public void afficher(){
       System.out.println("a is: " + a);
   }
}
public class Test{
   public static void main(String[] args){
       Tester T = new Tester();
       T.afficher();
   }
}

这是生成的 Java 文档文件的屏幕截图,其中根本没有列出已弃用的方法:

enter image description here

最佳答案

正如评论中所指出的:Tester 类将不会被记录,因为它不被视为与 javadoc 相关。 默认情况下,仅收集 publicprotected 用于文档 (http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html)。

要么改变它的可见性(例如让它protectedpublic),要么生成带有标记-package- 的javadoc私有(private)。但请注意,您可能会生成大量文档,而您可能根本不需要这些文档。

javadoc -package Test.java

关于java - javadoc 中未提及的弃用方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40969698/

相关文章:

Eclipse:如何将 JavaDoc 附加到多个 JAR 文件?

java - 非法参数异常 : column '_id' does not exist?

intellij-idea - Java文档与IntelliJ IDEA中的错误消息重叠

Java:如何使用 Javadoc 创建美观的类文档?

java - 描述 API 用途

ISODateTimeFormat.dateTime() 的 javadoc

java - eclipse无法加载jni共享库

Java 连接到在 docker 中运行的 cassandra

java - 如何根据显示器尺寸调整桌面应用程序的大小

java - Java 安全更新后使用 SAXReader 时出现 StackOverFlowError