/**
* Gets the meatball icon for a nincompoop.
*
* <p>
* Example: {@code <custom:meatball color="<%= Meatball.RED %> nincompoop="${person}" />}
*
* @author King Cong
*
*/
"$ {person}"部分会破坏文档注释,因为它使用花括号.
我正在寻找一种方法将javadocs从我的开源项目(在Eclipse中生成)转换为GitHub MarkDown,或者想出一些其他简单的解决方案来在GitHub上显示我的文档(只是简单地添加一个docs目录).有一个简单的解决方案吗？我可以简单地将GitHub README.md指向我的docs目录吗？有更优雅的东西吗？我一直在谷歌上罢工.
我正在使用一个私有构造函数而不是枚举的类(这是一个要求).现在我正在尝试添加javadoc标记来记录每个public static final实体.
1)放置javadoc标签的首选位置:喜欢ob1还是ob2？
2)两个选项都会在IDEA中产生错误
@value tag must reference field with a constant intializer.
/**
* {@value #ob1} object1 description
*/
public class MyClass {
public static final Object ob1 = new Object();
/**
* {@value #ob2} object2 description
*/
public static final Object ob2 = new Object();
private MyClass() {}
}
有没有人遇到过下面的simlar maven错误？
由于下面的错误,我无法构建我的项目.在我开始编写代码之前,一切都工作得很好.
我甚至没有在下面定义的接口上工作,它似乎与javadoc有关？
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project jonney-project: MavenReportException: Error while creating archive:
[ERROR] Exit code: 1 - /Users/me/Work/myProject/library/src/main/java/com/me/someInterface.java:45: warning: no @return
[ERROR] public abstract boolean searchForDevce();
[ERROR] ^
[ERROR] /Users/me/Work/myProject/src/main/java/com/me/someInterfaceAgain.java:52: warning: no @return
[ERROR] public abstract boolean selectDevice(int pos);
[ERROR] ^
我想在注释块中使用@see链接另一个对象的方法@see
只给我链接类的选项,而不是方法.
什么是黑客？
public class A {
B bee;
/**
* Just invoking methodB on bee.
* @see B.methodB() <-- There
*/
public methodA() {
bee.methodB();
}
}
public class B {
/**
* The real stuff
*/
public methodB() {
// real stuff
}
}
当我有一个带注释的代码示例时,我的JavaDoc不起作用.
有什么建议？
/**
* <pre>
* public class Demo {
* @DemoAnnotation
* public void demoMethod() {
* }
* }
* </pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {
感谢这个主题,我能够在Windows上的Eclipse中为我的Android项目提供Javadoc链接.具体来说,"{@link android.widget.Toast}"目前已转换为" http://d.android.com/reference/android/widget/Toast.html?is-external=true " 的链接.我用Javadoc选项实现了这个目的:
-linkoffline http://d.android.com/reference"file:/ C:/ Android/android-sdk-windows/docs/reference"
但是,基于我的Java代码行(而不是Javadoc注释),我得到以下错误:
C:\Users\Ellen\workspace\TestableToast\src\edu\mills\cs180\HelloAndroid.java:5:
package android.view does not exist
import android.view.View;
^
C:\Users\Ellen\workspace\TestableToast\src\edu\mills\cs180\HelloAndroid.java:6:
package android.view.View does not exist
import android.view.View.OnClickListener;
^
C:\Users\Ellen\workspace\TestableToast\src\edu\mills\cs180\HelloAndroid.java:8:
package android.widget does not exist
import android.widget.Toast;
^
C:\Users\Ellen\workspace\TestableToast\src\edu\mills\cs180\HelloAndroid.java:10:
cannot find symbol symbol: class Activity
public class HelloAndroid extends Activity implements OnClickListener {
^
我该如何修复这些参考文献？
这就是我想要做的:
/**
* <pre>
* {@code
* @XmlRootElement
* public final class Page {
* }
* }
* </pre>
*/
我希望它的格式如下:
@XmlRootElement
public final class Page {
}
但是我得到了:
@XmlRootElement
public final class Page {
}
与真正的符号替换这些HTML实体(@,{,})导致的Javadoc警告,绝对不正确的格式.什么是变通方法？
我正在寻找一段时间,但没有找到.如何在NetBeans 7.0.1中创建文档？
我的文件看起来像:
/** Class Description of MyClass */
public class ScanReader{
}
在我的项目属性中,我使用复选框选中了所有选项,而Javadoc选项中没有任何选项(我尝试使用全局路径-d但没有任何反应).当我进行构建或构建和清理时,我没有看到任何关于文档的内容,也没有任何新的项目文件.
考虑一个类中的静态方法,我已经使用javadoc记录了它:
/**
* Description here.
*
* @param names - The parameters of the impression request.
* @param ids - An intent object to enrich.
* @param prefix - A prefix.
*/
public static void parse(Map<String, String> names, String ids, String prefix)
...
为了避免重复方法的重载版本中的描述,我想使用javadoc @link:
/**
* Overloaded version with default prefix.
* {@link #<parse(Map<String, String>, String, String)> [Text]}
*/
public static void parse(Map<String, String> names, String ids, String prefix)
这给出了以下警告:
@link:illegal character: "60" in "#parseBtCategories(Map<String, String>, …