如何为类似功能重用javadoc
假设我具有以下功能: /** * Thorough explanation * */ public void somethingImportant(String parameter) { (...) } 为方便起见，我添加以下功能: public void somethingImportant() { somethingImportant(null); } 这
..
javadoc相关内容
Eclipse Javadoc注释中的换行错误
我认为，Eclipse内置Java格式化程序中有一个小而烦人的错误.我有一个Javadoc注释，看起来像这样: /** * - - - stuff - - - {@code mTasksBelow}. */ 其中结尾的句点在第81列中.格式化程序设置为在第80行包装Javadoc注释.不幸的是，当我格式化代码时，它是这样做的: /** * - - - stuff - - -
..
Javadoc无法识别doctitle选项/标志
我正在通过gradle使用doclet运行javadoc，并且当我运行javadoc/doclet任务时，我收到下一个错误: error - invalid flag: -doctitle 然后是下一个用法表 usage: javadoc [options] [packagenames] [sourcefiles] [@files] -overview
..
使用JavaDoc记录地图的标准方法是什么?
我正在记录一些代码，并且有一个私有的HashMap.我想指定有关键和值所期望的信息.现在我有: /** * HashMap where key=word, value=part of speech */ private HashMap dictionary; 但是，这似乎很难读懂，而且当我遇到更复杂的内容时，它也无法正常工作 HashMap
..
如何记录Java副作用
是否有针对包含副作用的Java/JVM语言方法编写javadocs的标准或最佳实践? 我定义了一个void方法，该方法修改了方法参数之一，但不知道如何记录实际的返回值(因为没有实际的返回值). /** * @param obj - reference object * @return obj - obj.name is changed to 'hello' //TODO fig
..
Android Studio-Gradle生成特定的Javadoc文件
我需要为包含3个模块的项目生成一些Javadoc，并且只需要每个模块中的特定文件即可. 在Android Studio中，我可以转到工具->生成JavaDoc，然后设置自定义范围，并有选择地选择所需的文件，然后将它们聚合到单个javadoc文件夹中，但这不适用于我们的自动构建. 我不知道如何在gradle命令行上做到这一点? 每个例子都是该任务的一些变体 task java
..
如何用Java实现String.charAt(int i)?
如果我想使用String.charAt(int i)检查字符串中的每个字符，它是从开始算起还是自动转换为数组并直接获取charAt索引? 如果我通过String.toCharArray()创建一个char数组然后按索引遍历该数组，会更有效吗? 我可以在JavaDoc中进行检查吗?在哪里? 解决方案 JRE主要是开源的.您可以在此处下载zip文件，也可以使用 public cha
..
为什么@Documented注释具有运行时保留?
我知道，@Documented批注仅由javadoc生成器使用以从源生成javadocs.因此保留类型应为SOURCE，但应为RUNTIME.为什么? @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Documented { } 解
..
禁用Javadoc检查以获取Bintray上传
我正在尝试将我的图书馆的新版本上传到Bintray，但是我遇到了错误. 我所做的更改之一是向Javadoc添加自定义属性.例如: /** * The method does something. * * @param myParameter This is my parameter * @see #anotherMethod(int) * @attr ref R.stylea
..
将多个模块的Javadoc合并到一个集合中
我有一个由几个模块组成的Java应用程序.我想为所有这些文件一起生成Javadoc:也就是说，从这几个模块中，我想要一个HTML文件集合，其中包含一个index.html，一个allclasses-frame.html等，以及各种HTML文件.超链接应可跨模块使用. 我使用Maven，但不一定要局限于Maven特定的解决方案.这将由cron作业执行，因此也可以使用其他工具. 在这种情况
..
如何记录(简单)Java方法的前提条件?
通常情况下，方法对其类型的参数施加约束，而类型系统无法描述这些约束.例如，一种方法可能要求某些参数为非空，或某些int类型的参数为正.可能还存在更复杂的前提条件，例如，之前调用过某种方法，或者某个对象处于某种状态.用Javadoc记录此内容的最佳方法是什么? 例如，假设我具有以下公共库函数，其中参数不能为负: public void foo(int bar) { if (bar
..
如何编写好的Javadoc注释?
我是Java开发人员，我对提高我编写的代码和程序中Javadoc注释的质量感兴趣，以使其他开发人员更容易理解和实现它. 我已经阅读了许多文章，包括来自官方的文章，并且我尝试遵循书中所述的准则 "Java风格的元素" ，但是尽管如此，并且在网上进行了广泛搜索之后，我还是似乎找不到一种实用的方法来比较我现有的Javadoc和模型示例并维护Java API文档的最佳做法. 解决方案 同行评
..
“字段摘要"在Java api doc上
当我阅读Java的API文档时，会看到一个名为“字段摘要"的字段. 这部分是做什么用的?. 在此字段中，常量和类的用途是什么? 谢谢. 解决方案 生成的Javadoc页面的“字段摘要"用于汇总类的(通常是公共的和受保护的)字段，并提供指向更详细说明的链接页面下方的字段.与方法一样，字段摘要部分中的文本由关联的详细信息部分中的第一句话组成. 由于Java已经发展了良好的实践
..
Javadoc =>如何添加一个很酷的标题标签
我试图在我的javadocs上添加这种类型的标题部分，但我无法以一种简单而有用的方式来实现.我唯一可以做到的方法就是使用HTML，而且我认为HTML在代码中不应该占有一席之地. 这是我制作的javadoc的示例.我希望我的javadoc看起来完全像机器人一样，所以我希望添加带有红色正方形的标题部分，而无需使用HTML. 解决方案 如果希望生成的文档包含指向java.lang.Stri
..
如何使用Gradle在Android Studio中生成JavaDoc?
我找不到有关如何配置Gradle文件为我的项目创建JavaDoc的任何文档.我已经尝试过SO和博客文章中的一些片段，但它们似乎都没有作用，或者它们不提供上下文. 这是我的Gradle文件.我需要做些什么来添加任务来生成JavaDoc? import org.apache.tools.ant.taskdefs.condition.Os apply plugin: 'com.androi
..
如何使用SBT跳过Javadoc依赖项下载
1)Javadoc工件倾向于占用太多空间和时间来下载. 例如，scala-library-2.10.2-sources.jar为1 Mb，但scala-library-2.10.2-javadoc.jar为34 Mb. 2)几乎根本不需要Javadoc.由于现代的IDE可以从源中获取所有信息. 所以我想找到一种方法来更改sbt设置，以完全禁用第三方库依赖项之间的javadoc下载.
..
Maven JavaDoc-如何包括集中式资源
我正在尝试将集中式资源(例如，图像文件，js文件)包含到我的Maven生成的Javadoc中.这样的集中资源将来自依赖项. (就我而言，我总是希望包含某些资源，Javascript文件，从而可以在Javadoc中对示例代码进行漂亮的语法高亮显示，并且还可以使用特殊的样式表) 如果您在项目中本地包含资源，则有很多有关如何执行此操作的信息.这不是我想要的，因为我需要为公司的每个项目执行此操作.因
..
使用Javadoc -link选项链接到javadoc.io
我正在尝试使用@link选项链接到托管在javadoc.io上的某些Javadocs(特别是PowerMock的Javadocs).我试图将PowerMock的Javadocs的URL添加到我的-link标志，但是无法使Javadoc识别它.我正在使用Gradle作为构建系统来很好地连接到其他Javadocs的外部链接(例如Guava，Java SE 7).我尝试了以下选项: -link h
..
在Java中使用JMustache实现lambda函数
我正在关注JMustache的文档: https://github.com/samskivert/jmustache .它说我们可以调用Java函数并在Mustache模板中使用它们.我有一个lambda函数，像这样 Mustache.Lambda lookupInstance = new Mustache.Lambda() { public void execute (Tem
..
是否可以在JavaDoc中重用@param描述?
我有一个用于编码URI的便捷类.在其中，我创建了三种方法，这些方法取决于我需要的具体程度.我想知道在这种情况下是否使用JavaDoc重用@param描述? (我还没找到) public class URLCreator { public static String getURLString(String host, int port, String path) { r
..