草庐IT

javadocs

全部标签

单行上的 Javadoc 多个变量

我有一个像下面这样的类......classA{/***Blahblah*/Type1var;/***WhatdoIdohere?*/Type2var11,var12;}如果var11和var12在同一行,我如何编写javadoc?我很想知道这是否可行,我知道我可以将它们放在单独的行中并从那里放置javadoc。 最佳答案 我很好奇就试了一下/***datastuff*/intx,y;生成的javadoc对x和y重复相同的文档注释。我想如果两个字段本质上相同,只有细微差别,这种行为会很有用。classCircle{..../***c

java - 如何将在线可用的 javadoc 添加到 Netbeans 中下载的库?

也许答案很简单,但我无法在google上找到有关该主题的信息。我已经从http://code.google.com/p/macwidgets/下载了MacWidgets库.在该站点上,您还可以找到javadoc,我想将其集成到Netbeans中,以便在像在普通javaapi上一样键入时为我提供有关类/方法的信息。这有可能吗?还是我必须下载源代码,从中创建项目并引用项目而不是库? 最佳答案 我确认了在http://www.netbeans.org上发布的最新NetBeansIDE7.0M2版本他们为Javadoc提供了URL配置支持。

java - 如何在 JavaDoc 中包含 @Annotations?

这个问题在这里已经有了答案:Isthereawaytogetthejavadoctooltodocumentannotations?(1个回答)关闭4年前。我想在JavaDoc中记录类和方法的一些属性,并能够在运行时加载这些信息。因此,我认为编写自定义注释并使用此注释注释所有必要的文件和方法可能会很方便。有了这个注释,我可以在运行时加载这些信息。这是一个假设的代码片段来演示我的用例:publicclassImportantClass{@DetailedDescription(description="originatedfromdatasourceXYZ")publicvoidimpo

java - 除了 Javadoc 之外,JDK 类是否有任何进一步的规范?

除了Javadoc之外,JDK类是否有任何进一步的规范?如果有,在哪里?例如,考虑Collections.unmodifiableMap。ItsJavadoc没有说任何关于线程安全的事情;因此,仅从Javadoc出发,我不能假设在不采取我自​​己的一些特殊步骤来获得线程安全的情况下将生成的映射公开给其他线程是安全的。但是恕我直言,任何现实的实现都会将内部映射存储在final字段中,因此在Java5和更高版本中,只要内部映射是(“发生”-before”结果映射的任何访问与之前对内部映射的任何修改之间的关系)。例如,这就是OpenJDK实现所做的。那么,我怎样才能确定我是否可以便携地假设给

仅用于 package-info.java 的 javadoc

我有一种情况,我想在没有类的项目中执行javadoc。它只有一个包的package-info.java。执行javadoc时报错如下:AnerrorhasoccurredinJavaDocsreportgeneration:Exitcode:1-javadoc:error-Nopublicorprotectedclassesfoundtodocument.有没有办法强制它只处理package-info.java(除了明显的hacky解决方案:创建一个虚拟类,编写package.html的复制脚本等)?我正在执行javadoc作为maven构建的一部分,因此maven-javadoc-p

java - 将 javadoc 生成为 word 文档

我们如何将javadoc生成为word文档而不是传统的html页面? 最佳答案 查看doclet,http://doclet.com其中有大量自定义javadoc呈现的示例(即转换为PDF等...),还查看ApachePOI(http://poi.apache.org/)以生成MSOffice文件 关于java-将javadoc生成为word文档,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/que

java - 如何将图像包含到 javadoc 中并引用它们

我检查了manualofjavadoc并在stackoverflow上阅读了一些帖子(例如Includingimagesinjavadocs)但无法获得满意的结果我想在我的javadoc中提供一个图像,它应该与创建的html打包在一起。以下是我采取的步骤:创建一个doc-files以下目录src/main/java(这是STS中的gradle项目)放置一个名为classhierarchy.png的文件进入新创建的目录添加我类(class)的javadocde.company.some.more.levels.MyClass创建javadoc我可以看到png文件被复制到C:\temp\N

java - Java 8 中的 Javadoc 不完整?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭7年前。ImprovethisquestionJava8的Javadoc是否不完整?一些方法注释被省略,方法描述被(错误地)从基类复制(例如java.util.IntSummaryStatisticstoString()方法带有注释“从类复制的描述:对象”。publicStringtoString()Descriptioncopiedfromclass:ObjectReturnsastringrepresentationoftheob

Javadoc 结束标记

这个问题在这里已经有了答案:WhichtagshouldbeusedasparagraphseparatorinJavadoc?(3个答案)关闭7年前。阅读Oracle'sJavadocDocumentation,我注意到作者没有关闭标签。/***Themethodusedforcreatingthetree.Anystructural*modificationstothedisplayoftheJtreeshouldbedone*byoverridingthismethod.**ThismethodaddsananonymousTreeSelectionListenerto*ther

java - maven 项目需要 sun.javadoc jar

我遇到了这个http://mvnrepository.com/artifact/javadoc/javadoc但它表示sun不允许重新分配。我有一个需要使用com.sun.javadoc.*的Maven项目。我可以使用哪个存储库来获取依赖项?p/s:我用的是eclipseorg.apache.maven.pluginsmaven-javadoc-plugin2.5 最佳答案 我不确定这是你要问的,但是com.sun.javadoc中的类在tools.jar中(无法分发).如果出于某种原因您需要在类路径中使用这些类,请添加以下依赖项: