JavaDoc中帶註釋的代碼示例

當我有一個註釋的代碼示例時，我的JavaDoc不起作用。JavaDoc中帶註釋的代碼示例

有什麼建議嗎？

/** 
* <pre> 
* public class Demo { 
* @DemoAnnotation 
* public void demoMethod() { 
* } 
* } 
* </pre> 
*/ 
@Retention(RetentionPolicy.RUNTIME) 
@Target({ElementType.METHOD}) 
public @interface DemoAnnotation {

來源

2010-04-14 John

您必須在JavaDoc的@更換@。

來源

2010-04-14 09:03:34 Espen

一個更通用的解決方案：{@literal @}

的{@literal}標籤表示文字文本。附上的文本被解釋爲不包含HTML標記或嵌套的javadoc標記。例如，doc評論文本：{@literal a<B>c}將在生成的HTML頁面中顯示不變：a<B>c - 也就是說，<B>不會被解釋爲粗體。

需要Java 5+

來源

2012-04-05 19:54:07

恕我直言，這應該是接受的答案。 – BetaRide 2014-09-05 07:33:22

在實際嘗試之前Upvoted它，但後來我發現了一個問題：使用'{@literal @}'在@之前添加了一個醜陋的空間（至少在NetBeans中查看時）。 '@'不會（例如，它在JUnit javadoc中使用）。哦，*和*它在'@ code'內不起作用（'@'）。 – 2016-09-29 13:26:51

@SergeyTachenov無法使用命令行javadoc重現您的空間問題。「@ code」行爲是設計的;請參考此答案，以獲取有關如何在javadoc中嵌入複雜代碼片段的好建議：http://stackoverflow.com/a/13512524/159570 – 2016-09-30 08:14:19

-3

必須使用@Documented標註在javadoc中添加註釋。檢查在API的實施

來源

2012-12-26 08:40:40

這是不正確的：請閱讀https://docs.oracle.com/javase/ 7 /文檔/ API /爪哇/郎/註解/ Documented.html – Marco 2015-05-13 09:58:25

JavaDoc中帶註釋的代碼示例

回答

相關問題