Tag: javadoc

如何添加包级别注释或编辑package-info.java?

我正在尝试添加包级别的注释,但是我不知道如何去做。 例子表示赞赏。

任何方式来自动生成Eclipse中的所有Javadoc评论?

我知道你可以按shift + alt + j为当前的代码块插入一个合适的注释模板,但是有没有什么办法让eclipse变得疯狂,做这样的整个项目?

如何使生成的类包含来自XML Schema文档的Javadoc

我目前正在处理大多数types和元素都有<xsd:annotation> / <xsd:documentation>的XML模式。 当我从这个XML Schema生成Java Beans时,那些Bean的Javadoc只包含一些关于types/元素的允许内容的通用生成信息。 我希望在相关位置看到<xsd:documentation>标记的内容(例如,为了表示该complexType而生成的类的Javadoc中将显示该types的标记的内容)。 有没有办法做到这一点? 编辑 :这个XML Schema将用于带有JAX-WS的WSDL,所以这个标签也可能是合适的。 编辑2 :我读过关于<jxb:javadoc> 。 根据我的理解,我可以在单独的JAXB绑定文件中指定,也可以直接在XML模式中指定。 这几乎可以解决我的问题。 但是我宁愿使用现有的<xsd:documentation>标记,因为Javadoc不是文档的主要目标(主要是关于数据结构的信息,而不是关于由它生成的Java Bean的信息),并允许非JAXB工具也可以访问这些信息。 在<jxb:javadoc>和xsd:documentation> “感觉”是错误的,因为我没有很好的理由重复数据(和工作)。 编辑3 :感谢Pascal的回答,我意识到我已经有了一半的解决scheme: complexType的<xsd:documentation>被写入到它的Javadoc的开头! 问题仍然是只使用complexType s和simpleType s(这也可能导致类),而元素仍然是Javadoc-less。

如何使用Android Studio创build没有R和BuildConfig的JavaDoc?

我想为我的库生成JavaDoc,不包括R和BuildConfig。 “ Tools菜单中的“ Generate JavaDoc…function不具有排除文件的选项。 如何使用Android Studio创build没有R和BuildConfig的JavaDoc?

在Eclipse中添加作者名称自动到现有的文件

有没有一个真正的易于使用的工具(无怪物工具),我可以插入到Eclipse,并按下“生成标题”button,然后作者的名字出现在该项目的每个文件?

如何下载javadoc脱机阅读?

我只是知道javadoc页面在线阅读,但我想下载它在没有networking可用时脱机阅读。 那我该如何下载呢?

如何在Javadoc中添加包级别评论?

我正在使用Check-Style,FindBugs和PMD来validation我的Java代码。 我修复了几乎所有被这些工具捕获的错误。 我无法理解如何编写“包评论”,这是checkstyle捕获的错误。 我已经通过了Check-Style的文档,但我不明白。 有人可以帮我在Java中编写一个包级别的评论吗?

Eclipse格式化程序在空注释行中添加空间

eclipse代码格式化程序在每个空的Javadoc注释行中添加一个尾随空格(见截图)。 同事的格式化程序总是删除这些空间(从而产生令人讨厌的SVN差异)。 他声称使用相同的格式化程序设置(XML文件)。 不过,我尝试了格式化程序设置页面的注释选项卡中的所有选项 – 没有成功。 它可以是日食版本之间的差异? (我相信我使用的是基于Helios的Springsource Tool Suite 2.7.1)

Javadoc {@inheritDoc}标签类

我想使用{@inheritDoc}类从我的抽象类inheritance方法。 在抽象类的文档中,我指的是抽象类的名称。 当子类inheritance超类的文档时,如何标记这个名称,用子类名replace抽象类的名字?

我可以使用Eclipse轻松地将JavaDoc添加到包中吗?

我使用javadoc来logging我的类和方法。 我想向我的软件包添加一些概述信息。 我喜欢Eclipse如何为每个类或方法创build一个匹配的文档注释的存根(stub),一旦我键入/**<Enter> 。 Eclipse是否也有一个简单的方法来生成package.html文件 ?