草庐IT

non-javadoc

全部标签

java - 配置 Gradle 以发布源代码和 javadoc

如何配置Gradle以将源代码和javadocjar发布到存储库? 最佳答案 Gradle6.0的解决方案如果您使用的是Gradle6.0或更高版本,这里是您可以使用的最小配置;注意新引入的withSourcesJar()和withJavadocJar()方法:plugins{id'java'id'maven-publish'}group='com.example'java{withSourcesJar()withJavadocJar()}publishing{repositories{maven{url='file:///tmp/

Javadoc 使用相对路径链接到 src/main/resource 或 src/test/resource 文件

如果有一种方法可以在javadoc中放置一个指向驻留在src/main/resources或src/test/resources中的标准资源文件的链接,以便其他编码人员可以快速导航到资源文件,我会发现它非常有用(在本例中为JSON文件)在IntelliJ中。这些文件用于单元测试,需要随着架构的变化而经常修改。答案在这里Linktotextfile(resource)inJavadoc没有帮助,因为绝对路径太脆弱了。有没有办法用资源做与@see相同的事情?如果javadoc本身有不足之处,IntelliJ特有的东西会很棒。 最佳答案

java - 使 JavaDoc 对重构具有鲁棒性

我正在开发一个不断重构以改进它的应用程序。现在,如果我们重命名某个类以更好地捕捉其意图,所有提及该类的文档都不会自动更新,除非您使用链接({@linkClassName})来引用该类。然而,JavaDoc原则指出人们应该“经济地使用内联链接”,因为链接脱颖而出并引起读者的注意,我认为这是明智的。此外,您不能链接到方法的参数。JavaDoc中是否有另一种方法可以使注释对我不知道的重构更加健壮? 最佳答案 当使用eclipse进行重构时,您还可以在xml文件等内容中搜索字符串引用。按Shift-Alt-R两次以获取对话框。(在Mac上是

java - 使用 javadoc 忽略小错误

我正在尝试使用javadoc从一个或两个下载的jar文件生成文档(在提取所有内容之后,当然还有源代码)。但是使用javadoc,即使在Ant文件中,由于一些愚蠢的事情,特别是“包XXX不存在”和“找不到符号”,我被阻止生成这个...我只想让javadoc把这些东西(外部引用)在html文档中的文本,但要记录它找到的所有.java文件...请注意,对于任何感兴趣的人,这是带有下载文件(包含源代码)的下载页面,我试图从中生成API文档:http://logback.qos.ch/download.html在MarkRotteveel的帮助下,我的Ant构建文件现在看起来像这样:...但它仍

java - 使用@see 编写正确的javadoc?

如何正确使用@seejavadoc?我的意图是拥有一个带有抽象方法的抽象类。这些方法有javadoc注释。现在,如果我扩展抽象类,我将覆盖方法并希望使用@see。但对于所有参数,例如对于return,@see链接似乎不起作用。Eclipse仍然提示需要@return标记。那么我该如何使用呢?publicabstractclassMyBase{protectedabstractvoidmyFunc();}classMyImplextendsMyBase{/***@seeMyBase#myFunc()*/@OverrideprotectedvoidmyFunc(){..}}

java - 如何在 Eclipse 中获取 SWT 和 JFace 的 JavaDoc?

我是Eclipse的新手,不知道如何让SWT和JFace的JavaDocs在我编辑时显示出来。我该怎么做?谢谢! 最佳答案 我假设您已经自己下载了这些jar并在您的项目中引用了它们。如果是这样,您可以右键单击项目资源管理器中的jar(在“引用库”节点中),然后单击“属性”。在出现的窗口中,您可以定义jar的JavaDoc和源代码的位置(如果有的话)。您也可以通过单击“项目”>“属性”>“Java构建路径”>“库”并展开要添加javadoc/source的jar的节点来达到此目的。另外值得一提的是,如果您使用Maven(http://

java - 如何解决 FATAL : connection limit exceeded for non-superusers

我已经编写了用于批量插入的Java代码。我正在使用复制命令为不同的表导入和创建不同的连接对象,但在执行时,程序会抛出以下错误:FATAL:connectionlimitexceededfornon-superusers 最佳答案 您已超出PostgreSQL服务器的连接限制。有一些为super用户保留的连接。要增加连接限制,您必须更改postgresql.conf(默认100)它位于您的PostgreSQL数据目录中。catpostgresql.conf|grepmax_connectionmax_connections=100#(

java - 源代码和 Javadoc jar 生成

我觉得我的问题很简单。然而,令人惊讶的是我找不到任何简单的解决方案。我正在Netbeans上开发一个开源Java库项目,和其他许多人一样,我想将它作为binary.jar、source.jar和javadoc.jar发布。有没有办法在Netbeans上自动生成它们?我知道maven可以做到。但是学习曲线似乎太长了。有一个类似的问题,但唯一的答案没有用:AutomaticallygeneratingsourceanddocjarsinNetbeans 最佳答案 这是我最后想出的解决方案。它使用Ant并生成javadoc和源jar。然后

java - 如何创建多语言 JavaDocs?

有一个普通的JavaAPI的JavaDoc,有英文版和中文版,但是好像每个版本都需要单独的源代码。有没有更方便的方法来做到这一点? 最佳答案 不,基本上没有办法做到这一点。想到的唯一变通方法适用于生成的HTML页面:您可以将JavaDocs包围在使用CSS在语言之间切换的block元素中。考虑:/***DocumentationinEnglish*DocumentatieinNederlands*/publicvoidmyFunction(){}随后编辑JavaDocs的CSS,以便用户可以切换语言,例如:div.en{displa

Javadoc 继承父构造函数文档

假设我正在扩展一个类,例如:publicclassMyComboBoxextendsJComboBox{publicMyComboBox(){super();}publicMyComboBox(ComboBoxModelmodel){super(model);}}重新定义父类的构造函数(当然,它们适合我的新类)已经够烦人的了,但还要复制每个构造函数的文档就更糟了。更不用说它不利于进一步继承,因为我现在必须多次更新文档。显然,{@inheritDoc}不会工作,因为我没有覆盖任何内容。然而,这是我正在寻找的行为。有什么办法可以实现吗?如何继承父构造函数文档?