标签: javadoc

此操作的快捷方式是Shift + F1,但即使我已将JDK documentation path指向该docs文件夹(文件夹从jdk-7u2-apidocs.zip解压缩),它也始终显示为灰色.
谢谢

我想为我的库生成JavaDoc,不包括R和BuildConfig.菜单中的Generate JavaDoc...功能Tools无法排除文件.

如何在没有R和BuildConfig的情况下使用Android Studio创建JavaDoc？

我应该为所有java方法编写Doc Comments吗？

可能重复:
"/*(非javadoc)"是否有一个易于理解的含义？

以下陈述是什么意思？

    /* (non-Javadoc)
     * 
     * Standard class loader method to load a class and resolve it.
     * 
     * @see java.lang.ClassLoader#loadClass(java.lang.String)
     */
    @SuppressWarnings("unchecked")

我刚开始在我自己的项目中使用Java的枚举(我必须在工作中使用JDK 1.4)而且我对使用JavaDoc作为枚举的最佳实践感到困惑.

我发现这个方法有效,但结果代码有点未定义:

/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}

有没有什么方法可以在不用逗号链接它们的情况下拆分枚举声明,或者这是使用JavaDoc作为枚举的最佳方法？

如何使用新的Gradle构建系统为Android项目生成JavaDoc？

这是我提出的,但它不起作用.

task generateJavadoc(type: Javadoc) {
    source = android.sourceSets.main.java.srcDirs
    ext.cp = android.libraryVariants.collect { variant ->
        variant.javaCompile.classpath.files
    }
    classpath = files(ext.cp) 
}

主要问题是我没有在类路径上获得相应的android.jar,因此JavaDocs中的某些链接无法解析.我必须找到一种方法来获取类路径上所有必需的jar.

我采用的方法的另一个问题是它收集所有构建变体的类路径,而不是选择一个.

我应该为私有或受保护的方法编写JavaDoc 吗？私有变量怎么样？

我在Java书上看到了类示例,私有变量是JavaDoc.所以我无法理解JavaDoc 私有(或受保护)方法是否是一个好习惯.

我需要*/在我的JavaDoc评论中包含这些内容.问题是这也是关闭评论的顺序.引用/逃避这个的正确方法是什么？

例:

/**
 * Returns true if the specified string contains "*/".
 */
public boolean containsSpecialSequence(String str)

跟进:似乎我可以使用/斜线.唯一的缺点是,在文本编辑器中直接查看代码时,这并非完全可读.

/**
 * Returns true if the specified string contains "*/".
 */

是否有一个真正易于使用的工具(没有怪物工具),我可以插入Eclipse,并按"生成标题"按钮,然后作者名称出现在该项目的每个文件中？

为什么默认的IntelliJ默认类javadoc注释使用非标准语法？它不是用"User:jstauffer"创建一行,而是可以用"@author jstauffer"创建一行.它创建的其他行(日期和时间)可能没有使用javadoc语法,但为什么不在可用时使用javadoc语法？

这里有一个例子供参考:

/**
 * Created by IntelliJ IDEA.
 * User: jstauffer
 * Date: Nov 13, 2007
 * Time: 11:15:10 AM
 * To change this template use File | Settings | File Templates.
 */