2010-02-18 61 views
148

我如何逃避javadoc中的@符號?我正在嘗試在{@code}標記內使用它,它位於<pre>標記內。如何逃避javadoc中的@角色?

我已經嘗試過html跳轉&#64;的順序,但那沒用。

+0

現在它已經開始顯示罰款我調整了一些壓痕@ {}代碼塊中了!如果它很重要,這在Eclipse中。 – JayL 2010-02-18 18:01:52

+0

我仍然無法得到它的工作 – 2017-12-10 12:38:36

回答

211

使用{@literal} Javadoc標記:

/** 
* This is an "at" symbol: {@literal @} 
*/ 

這樣做的Javadoc將閱讀:

This is an "at" symbol: @ 

當然,這會爲任何文字工作,是「正式支持「顯示任何」特殊「字符的方式。

它也是最直接的 - 你不需要知道字符的十六進制代碼,你可以閱讀你輸入的內容!

+1

如何轉義符號? – ADTC 2013-09-06 09:01:27

+1

@ADTC你不能。你爲什麼想要? '}'在html中沒有特殊的含義。 – Bohemian 2013-09-07 04:06:18

+0

所以我想你只能把它分成兩個'literal'標籤。 – ADTC 2013-09-07 09:19:08

1

你得到的總體思路,嘗試使用八進制表示:&#064;

+5

這不是八進制。 – Joey 2015-06-10 12:35:52

+0

''@''的十六進制代碼點爲0x40,十進制代碼爲64 – 2015-12-21 12:15:26

41

只要寫爲HTML實體:

&#064; 

從文件 「javadoc - The Java API Documentation Generator

如果您想要用@字符開始一行,但不能解釋它,請使用HTML實體@。

這意味着,你可以使用HTML實體任何字符,你需要逃跑,實際上你可以:

文本必須寫在HTML與HTML實體和HTML標籤。您可以使用瀏覽器支持的任何版本的HTML。標準doclet通過包含級聯樣式表和框架在其他地方(文檔註釋之外)生成符合HTML 3.2標準的代碼。由於框架集,HTML 4.0是生成文件的首選。

例如,小於符號(<)和大於符號(>)的實體應寫爲&lt;&gt;。同樣,&符號(&)應該寫爲&amp;

+0

這對java6可以正常工作,但對於java5不可用 – 2010-03-06 06:02:20

+1

這個在字面上顯示在Eclipse中。 – 2012-11-16 16:26:17

+5

這似乎在JDK1中不起作用。8 – 2016-02-03 07:33:04

5

我的解決辦法是

/** 
* Mapper Test Helper. 
* 
* add the following annotations above the class 
* <pre>{@code 
* // junit5 
* @literal @ExtendWith(SpringExtension.class) 
* // junit4 
* @literal @RunWith(SpringRunner.class) 
* }</pre> 
*/ 
+1

只有在使用Java 8的{@ code'內部工作的東西。 – Alex 2018-01-26 08:14:57