Tag: javadoc

是否可以在JavaDoc中重用@param描述？

我有一个用于编码URI的便利类。 在其中我创建了三种方法，具体取决于我需要具体的方法。 我想知道在这种情况下使用JavaDoc是否有一种聪明的方法可以重用@param描述？ （我还没找到） public class URLCreator { public static String getURLString(String host, int port, String path) { return getURLString(“http”, host, port, path, null); } public static String getURLString(String scheme, String host, int port, String path) { return getURLString(scheme, host, port, path, null); } public static String getURLString(String scheme, String host, int port, String path, […]

Netbeans反复下载Javadoc

我使用Netbeans 7.0.1进行研究项目。 我的问题是，每次我想检查给定函数或类的javadoc（从自动完成菜单），Netbeans下载Javadoc并仅在它运行时缓存它。 如果我重新启动Netbeans，我必须再次下载javadoc。 有没有办法告诉Netbeans永远缓存Javadoc？ 我在Mac OS上工作。

用于禁用JavaDocs的注释

是否有注释声明某个方法不会包含在JavaDocs中，即使它是公开的？ 就像是： @nojavadocs public void foo(){ //… } PS我理解这里关于API的观点，但这些方法只是“不受支持”。 它们可以工作（并且必须公开才能从其他软件包访问），但是当我们的function与支持的使用方案无关时，我们不想打扰它们并回答有关如何使用它们的问题。 好的设计可能意味着将它们移动到另一个类，但它们逻辑上引用了类中的数据。

JavaDoc：私有字段和方法

我应该在私有字段和方法中使用哪些JavaDoc标记来生成javaDoc描述？

TCP套接字上的Ascii

任何人都可以通过TCP发送Ascii消息的示例？（无法在网上找到示例） 谢谢， 射线。

自定义index.html javadoc页面？

我正在使用ant任务运行javadoc： 我想更改默认的index.html页面以提供简短的用户指南。 我可以改变index.html将它复制到其他地方，并在javadoc的ant任务完成后重写它，但这似乎有点愚蠢。 是否有更常见的方法来实现这一目标？ 谢谢

Gradle中的注释处理器将源文件输出到构建/类，使javadoc失败。 怎么解决？

我有一个注释处理器，在构建时由Java编译器自动拾取（使用SPI）。 在gradle构建期间，此批注处理器的生成的java源放在构建/类中，因为Gradle告诉注释处理器这是输出生成的源文件的位置。 当运行标准的javadoc任务时，它会尝试为build / classes中的所有文件创建javadoc，包括* .java。 这很糟糕，因为javadoc只需要* .class文件，这使整个构建失败。 所以我的问题是： 这是Gradle bug /function吗？ 我该如何解决它/使它工作？

在gradle中将参数传递给编译器和javadoc

我正在尝试将Gradle作为现有项目的替代构建系统。 该项目利用sun.misc.Unsafe导致类似这样的警告： warning: Unsafe is internal proprietary API and may be removed in a future release import sun.misc.Unsafe; 要禁止此警告， -XDignore.symbol.file作为参数传递给当前ant脚本中的javac和javadoc。 为了在Gradle中抑制这些警告，我不得不求助于我觉得“脏”的黑客，我不太习惯。 apply plugin: ‘java’ compileJava { // I only managed to get this working when I forked // and passed ‘javac’ as an executable options.compilerArgs << '-XDignore.symbol.file' options.fork = true options.forkOptions.executable = 'javac' } javadoc […]

javadoc中的Unicode和注释？

某些编译器在JavaDoc和源代码注释中的非ASCII字符上失败。 Java源文件中关于Unicode的当前（Java 7）和未来（Java 8及更高版本）实践是什么？ IcedTea，OpenJDK和其他Java环境之间是否存在差异，以及语言规范的含义是什么？ 是否应该使用HTML 和转义在JavaDoc中转义所有非ASCII字符; 像代码？ 但Java //评论等同于什么？ 更新 ：注释表明可以使用任何字符集，并且在编译时需要指示源文件中使用的字符集。 我将研究这个，并将寻找有关如何通过Ant，Eclipse和Maven配置它的详细信息。

Javadocinheritance父构造函数文档

考虑我正在扩展一个类，如： public class MyComboBox extends JComboBox { public MyComboBox() { super(); } public MyComboBox(ComboBoxModel model ) { super(model); } } 重新定义父的构造函数（当然适合我的新类）很烦人，但是复制每个构造函数的文档甚至更糟。 更不用说它对于进一步inheritance是不好的，因为我现在必须多次更新文档。 显然， {@inheritDoc}不会起作用，因为我没有压倒任何东西。 然而，这是我正在寻找的行为。 有没有办法实现这个目标？ 如何inheritance父构造函数文档？