是否允許使用javadoc標記嵌套{@code {@link}}？

Question

我想在javadoc中的代碼標記內放置一個鏈接。以下是我的嘗試。

/** 
* This method builds XML. 
* <pre> 
* {@code 
* <Person {@link #companyId}='1234'/> 
* } 
* </pre> 
**/ 

但是在生成的Javadoc中，鏈接不存在。字符串{@link #companyId}='1234'即將到來。

• 是否允許嵌套javadoc標籤？
• 有沒有辦法在代碼中添加鏈接？

Answer 1

這取決於標籤。 {@code ...}標籤按原樣解釋其內容，即避免將內容解釋爲Javadoc或HTML。它與{@link ... }標籤的內容類似。

這裏是一個解決辦法：

/** 
* This method builds XML. 
* <pre> 
* {@code <Person }{@link #companyId}{@code ='1234'/>} 
* </pre> 
**/ 

Answer 2

在Eclipse中，至少，它的工作原理使用以下的任何根據，如果你之前或鏈接後要額外編碼的文本上。

{@code {@link foo} 
{@code {@link foo} {@code bar} 
{@code baz}{@code {@link foo} 
{@code baz}{@code {@link foo} {@code bar} 

無與倫比的大括號和獨立@code註解是必要的，以便爲這個工作。如果您不想在javadoc中輸入foo和bar之間的空格，則可以刪除最後一個@code之前的空格，儘管對於baz和foo之間的空格不能執行該空格。

eclipse使用的JavaDoc解析器成功地將其轉換爲帶有代碼格式的鏈接，所以它至少適用於臨時使用。然而，這並不是最佳實踐，並且可能在未來發生變化，所以如果您正在編寫的代碼將在大約一年後仍然可用，那麼您應該使用Paulo的解決方案。