在@see处理JavaDocs时我何时使用？它的用途是什么？
例如,如果MethodA呼叫MethodB然后做我必须把@see中MethodB的javadoc和引用MethodA,因为这就是所谓呢,还是我已经把一个引用MethodB从MethodA,因为它调用它.我已经阅读了@seeOracle网站上的内容,在我看来它非常模糊,它说它意味着"也看到"但不是真的意味着什么!
在接口中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？
当您自动生成注释时,大多数IDE会为实现生成非JavaDoc注释.具体方法不应该有描述吗？
当我为一个"简单"POJO类的属性/成员编写javadoc时,我常常发现自己处于两难境地,只持有属性和getter和setter(DTO风格)....
1)为属性写javadoc
或...
2)为getter写javadoc
如果我为属性编写javadoc,我的IDE(Eclipse)将(当然)在以后通过代码完成访问POJO时无法显示.并且没有标准的javadoc标记允许我将getter-javadoc链接到实际的属性javadoc.
一个例子:
public class SomeDomainClass {
/**
* The name of bla bla bla
*/
private String name;
/**
* @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc
*/
public String getName() {
return name;
}
所以,基本上有趣的是听到其他人如何让你的Eclipse IDE显示你的getter的javadoc属性描述 - 而不必复制javadoc注释.
截至目前,我正在考虑让我的练习只记录吸气剂而不是属性.但它似乎不是最好的解决方案......
使用JavaDoc,如何引用类中最终静态字段的值？
我希望???在此示例中替换为字段的值STATIC_FIELD.
/**
* This is a simple class with only one static field with the value ???.
*/
public class Simple {
/**
* We can reference the value with {@value} here,
* but how do we reference it in the class JavaDoc?
*/
public static final String STATIC_FIELD = "simple static field";
}
我正在从Eclipse迁移到Intellij Idea.我无法弄清楚的一件事是@authorJavaDoc标签的自动完成.@a在Eclipse中键入时,有两个提议:
@author - author name
@author
我如何在Intellij中实现第一个提案(甚至可能吗？)？如果可能,如何更改为作者姓名占位符插入的内容的模板？
当我将鼠标悬停在一个类上时,我想在eclipse中显示包含在jar文件中的javadoc注释.
例如,下载JODA-2.0后,获得三个罐子:
在eclipse中,[右键单击项目 - >属性 - > Java构建路径 - >库 - > ADD JAR ...]包含项目中的二进制文件(可以引用这些类),用于joda-time-2.0.jar.
但是如何链接其他两个jar文件中包含的sources/javadoc注释,以便当我将鼠标悬停在这些类上时,我会看到javadocs？
将其他两个jar(joda-time-2.0-javadoc.jar和joda-time-2.0-sources.jar)添加到构建路径不会链接javadoc或源.
我查看了JavaDoc参考,虽然我理解@see(各种链接)和{@inheritDoc}(超类JavaDoc注释的导出)之间的基本区别,但我需要澄清事情的实际实现方式.
在Eclipse IDE中,当我为继承的方法选择"Generate Element Comments"时(从接口或toString()覆盖等),它会创建以下注释
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
如果我需要产生的JavaDoc我应该离开它,取代@see用{@inheritDoc},或者把它真正的Javadoc这样的:
/**
* {@inheritDoc}
*/
当我这样做时,我是否应该保持类#方法标志？
让我们面对现实:您不需要成为设计师就能看到默认的Javadoc看起来很难看.
网上有一些资源可以提供重新设计的Javadoc.但默认行为代表产品,应该看起来相当好看.
另一个问题是,与其他类似资源相比,Javadoc的可用性并不是最新的.
特别是巨大的项目很难使用Firefox的快速搜索进行导航.
实际问题:
是否有任何独立(桌面)应用程序能够以比浏览器更有用的方式浏览现有的Javadoc？
我正在考虑像Mono的文档浏览器这样的东西.
理论问题:
有没有人知道,如果有一些计划以某种方式标准化的方式发展Javadoc？
编辑: 有关此主题的Sun维基的有用链接.
目前我正在使用JavaFX.每当我将鼠标悬停在JavaFX的方法上时,它都会给我以下错误:
'Note: This element neither has attached source nor attached Javadoc and hence no Javadoc could be found'
我该如何解决这个问题？如何附加javadoc或源代码以便我可以看到方法的描述？
如何创建一个私有字段的javadoc链接？
class Foo {
private String bar;
public String getBar() { return bar; }
}
{@link Foo#getBar()} 作品.
{@link Foo#bar} 没有.