【Javadoc】教程文章相关的互联网学习教程文章

JavaDoc无法在Android项目中运行

我在Ubuntu 10.04上使用Eclipse 3.5.2进行Android开发.我安装了: > Sun的JDK来自Ubuntu的存储库;> eclipse.org上的Eclipse 3.5.2(Classic),解压缩到/ opt / eclipse>来自android.com的Android SDK,解压缩到/ opt / android-sdk 我的问题是,当我在Android项目中时,JavaDoc将无法工作(既不适用于Android类也不适用于Java类).例如,如果我将鼠标悬停在DateFormat上,我会得到:java.text.DateFormat Note: The Javadoc for this elemen...

Android Studio在生成JavaDoc时无法读取包【代码】

到目前为止,我已经在this,this和this中看到了Eclipse Javadoc的问题,但这些问题仅适用于Eclipse.但我想要它用于ANDROID STUDIO.我的项目有子模块和自定义视图.以下是错误:BootStarp1\Base-App\src\main\java\com\rspllib\android\utils\FileUpload\CustomMultiPartEntity.java:3: error: package android.util does not exist import android.util.Log;^ D:\MonkeyTalk\MonkeyStudioWorkspace\BootStarp1\Base-App\src\main\java\...

为什么我在String源代码中看到构造函数,但在JavaDocs中却没有?【代码】

我试图更熟悉使用JavaDocs.我正在查看String函数,我认为String非常有趣,它实际上只是一个私有引用变量中保存的字符数组. 当我查看String的源代码时,它显示了一个构造函数,如下所示:String(int offset, int count, char value[]) {this.value = value;this.offset = offset;this.count = count; }然后我去看看String JavaDoc,它没有显示带有那种签名的构造函数.是什么给出的?解决方法:正如Oli在上面的评论中提到的那样,构造函数不...

如何向javadoc学习

鉴于一个包含数百个类和接口的庞大(第三方)库,我发现很难跟随Javadoc: – 跟踪班级层次, – 比较/对比相关的类/接口. 目标是找出差异,了解类/接口做什么/不做什么,以便能够正确有效地使用库. 目前是否有一个工具采用给定类/接口的javadoc,生成其层次结构图,并比较/对比孩子及其父母/祖父母/兄弟姐妹的差异? 当然,这可以手动完成,但每次都耗费时间.有没有更有效的方法来做到这一点?谢谢. 编辑: – 我应该补充一点,我无权访问该...

如何只生成一个包的javadoc【代码】

我只通过Netbeans javadoc生成一个特定的包.如果我按下面板“Generate Javadocs”,我获得了所有项目的Javadoc.相反我只想一个包.解决方法:您可以使用packagenames参数.句法:javadoc [ options ] [ packagenames ] [ sourcefilenames ] [ -subpackages pkg1:pkg2:... ] [ @argfiles ] Documentation:packagenames –A series of names of packages, separated by spaces, such as java.lang java.lang.reflect java.awt. You must...

使用Maven自动验证JavaDoc【代码】

在重构期间,JavaDoc经常发生过时.它描述的方法参数不再存在,或者缺少一些新的参数,以举例说明. 如果有一个Maven插件可以自动检查现有的JavaDoc并在存在某种“JavaDoc违规”时停止构建,那就没问题了.我已经看过Maven-JavaDoc-Plugin和maven-doccheck,但两者似乎只能在违规的情况下自动修复现有的JavaDoc,而不是惹恼一些错误或警告. 有谁知道如果有这样的Maven插件以及如何存档这个?解决方法:据我所知,maven-javadoc-plugin目前无法...

内部/嵌套类构造函数的正确“@link”或“@see”javadoc标记是什么?【代码】

我在使用“@link”和“@see”标签来处理内部/嵌套类的构造函数时遇到了问题,并希望有人可以提供帮助.这个简短的示例类在第25行上提供了javadoc警告,引用了“Layer()”文档前面几行中的“@link”和(等效)“@see”标记.package bogus; import javax.swing.JPanel; public class LayeredPlot extends JPanel {/*** Constructor for the plot.*/public LayeredPlot() {}public static class Layer {private String name;/*** Construct...

JavaDoc:减少同一类中重复方法描述的冗余【代码】

例如,我有两种方法,公共树< T> addChild(final T data){}和public Tree< T> addChild(final T … data){},它们的JavaDocs完全相同.如何将/ **方法描述* /放在其中一个中,并使用标记将另一个JavaDoc引用到前一个? 就像在概念中一样:/*** method description*/ public Tree<T> addChild(final T data) { ... }/*** @theTag #addChild(Object)*/ public Tree<T> addChild(final T... data) { ... }如果我没记错的话,我偶然会遇到一个...

是否有用于识别过时/不一致的JavaDoc注释的工具?

我正在寻找可以指出不正确的JavaDoc注释的工具(或IDE功能).也就是说,具有缺少参数的注释,具有错误的参数名称,不记录抛出的异常等. 我知道没有一个完美的工具,因为工具无法告诉我们文档是否正确,但我希望识别更明显的错误至少可以帮助捕获一些不正确的JavaDoc注释. 最好这个工具可以忽略简单的getter和setter(例如,我通常不会在getter中包含@returns,因为它们的摘要详细说明了你需要知道的一切).解决方法:使用Eclipse,可以标记丢失或...

解释maven javadoc插件空标记错误【代码】

我正在尝试为我的项目构建javadocs,它给了我以下错误:[ERROR] /home/kshitiz/Documents/workspaces/ggts/log4j-weblayout/src/main/java/in/ksharma/weblayout/WebAppender.java:25: warning: empty <p> tag[ERROR] * <p>[ERROR] ^[ERROR] /home/kshitiz/Documents/workspaces/ggts/log4j-weblayout/src/main/java/in/ksharma/weblayout/WebAppender.java:30: error: unexpected end tag: </p>有问题的类有这个Javadoc:/*** <p>*...

如何在eclipse中使用Javadoc选项(例如-notdeprecated)?

我想生成javadoc但不包括已弃用的方法.我知道有一个名为-notdeprecated的选项(它可以满足我的要求),但我无法弄清楚如何指定这个选项. 为了生成javadoc,我转到Project-> Generate Javadoc.我可以在“使用标准doclet”和“使用自定义doclet”之间进行选择.我想我应该使用自定义doclet来使用选项(我错了吗?).现在,在哪里以及如何指定选项? 我使用eclipse 3.4.2解决方法:至少在Eclipse 3.5上,在向导的第三页中,有Extra Javadoc选项.

如果不是所有公共事物都是JavaDoc,如何强制编译警告?

我想在编译时获取没有Javadoc注释的每个公共事物(类,接口,字段,方法)的警告. 如何在Eclipse中启用它?解决方法:根据你的标签,我会假设你在Eclipse中的意思.为此,请打开窗口 – >首选项菜单项,然后在Java下 – >编译器 – > Javadoc,会有一个下拉列表,可以让您将缺少的javadoc标记视为错误,警告或忽略. 这个答案是针对最新版本的eclipse,但如果你在偏好搜索中搜索javadoc,你应该能够轻松找到它.

Eclipse无法识别Android兼容性Javadoc【代码】

我正在尝试在我正在创建的Android应用程序中使用v4兼容包,但Eclipse似乎无法找到Javadoc.我将兼容性jar(android-support-v4.jar)放在文件夹libs中,并在项目构建路径中引用它.然后我使用创建了Javadocjavadoc -d docs -sourcepath src\java -subpackages android.support.v4在控制台中,这很好.当我将它指向文件夹时,Eclipse说它是一个有效的Javadoc,但是在我创建的任何代码上使用兼容性包它只是说“这个元素既没有附加源也没有附加J...

在gradle javadoc构建中排除受保护的方法【代码】

我写了几个带有protected和public方法的实用程序类.我想从Gradle生成时从javadocs中排除所有受保护的方法. 在eclipse中,我们可以通过传递’-protected’参数来实现它,但它在Gradle中不起作用. 请告诉我如何在Gradle中完成.解决方法:将以下代码段放入build.gradle文件中:javadoc {options.memberLevel = JavadocMemberLevel.PUBLIC }

如果我在JavaDocs中使用,有人会杀了我吗?【代码】

我最近开始编写Java代码,我经常看到单个< p>用于分隔线条的标签.但就我的目的而言,我实际上并不想制作“段落”,而只是制作换行符,所以读取文档并不会那么糟糕.是< br>标签可以忍受吗? 最后,我想出了适合该项目的3种风格的文档.我会被杀的是什么? >在代码中看起来不错,在文档查看中看起来不好/*** <p> Does highly important adorable things. </p>* <p> Not only helping fields in being suitable* for stack overflow...