标签: javadoc

我可以在Android studio中使用快捷键来生成javadoc注释吗？

如果没有,生成javadoc注释的最简单方法是什么？

有什么区别

/**
 * comment
 *
 *
 */

和

/*
 * 
 * comment
 *
 */

在Java？我应该什么时候使用它们？

在Java API中,我可以看到包的Javadoc注释.

我如何/在何处放置Javadoc注释来记录包？

我知道这不是最重要的问题,但我只是意识到我可以在注释之前或之后放置javadoc注释块.我们希望采用什么作为编码标准？

/**
 * This is a javadoc comment before the annotation 
 */
@Component
public class MyClass {

    @Autowired
    /**
     * This is a javadoc comment after the annotation
     */
    private MyOtherClass other;
}

有人能告诉我javadoc @see和{@link}？之间的区别吗？

或者更确切地说,何时使用它们中的哪一个？

我正在使用Maven(以及Maven Eclipse Integration)来管理Eclipse中Java项目的依赖项.来自Maven存储库的JAR文件的自动下载功能可以节省时间.不幸的是,它不包括API文档和源代码.

如何设置Maven以自动获取源和javadoc附件并使用Eclipse正确注册它们？

我怎样才能逃避@javadoc中的符号？我试图在{@code}标签内部使用它,这是<pre>标签内部.

我已经尝试过html转义@序列,但这不起作用.

我在我的项目代码中编写了这样的Javadoc样式注释:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

如何使用Eclipse IDE生成Javadoc HTML文件？

我一直在浏览Sun网站上的javadoc文档,试图找出是否有一个javadoc标签可用于记录类或方法的泛型类型签名.

@typeparam类似于通常的东西@param,但适用于类型和方法,例如

/**
 *  @typeparam T This describes my type parameter
 */
class MyClass<T> {
}

我怀疑没有这样的标签 - 我在任何地方都找不到它,并且JavaSE API文档没有显示任何迹象,但它似乎是一个奇怪的遗漏.有人能把我说得对吗？

我最近从Eclipse搬到了Android Studio,我很喜欢它.但是,我想念Eclipse中的悬停功能Javadoc.

我按照这里的说明添加了功能,但是,我的悬停不包含Javadoc.如果我使用我的文档快捷方式Ctrl+ Shift+ Space它将正确显示文档,但是,我真的希望它出现在工具提示中.

下面是我看到的截图.显然,这个方法应该有一个Javadoc.

我在所有方法/变量上都看到了这个.任何帮助表示赞赏.