本地變量的Javadoc？

簡短的問題：是否有可能爲本地變量創建Javadoc？（我只想在Eclipse中將它懸停在本地變量上的解釋）謝謝任何提示:-)本地變量的Javadoc？

可以包括變量描述成方法的Javadoc評論 –

有時當你必須調試其他人的代碼和局部變量是凌亂的，這將有助於。 – Ced

本地變量應該在其用法上方聲明幾行。如果需要，請使用常規評論。但更重要的是，保持方法簡短，爲他們選擇有意義的名字，並只在需要時聲明它們。大多數情況下，完全沒有必要評論局部變量。

身高

int numberOfBooks = books.size();

在

// the number of books 
int n; 
... // 50 lines of code 
n = books.size();

2012-05-12 18:31:00

我同意這是不必要的*大部分時間*，但只是比解決書籍和其他東西更復雜的東西，尤其是在做更復雜的計算等時。 –

不，它不支持，因爲Javadoc生成會忽略它。

2012-05-16 06:27:51 nitind

-3

是的，這是可能的。只需在變量上方定義一個常規javadoc註釋。

public class ExampleClass { 
    /** A really cool variable */ 
    int localVariable; 

    ...

現在您可以將鼠標懸停在代碼的變量上方，並且會顯示註釋。

2014-04-29 07:02:20 chrizdekok

這對我不適用 – Devid

我也想過情況就是如此。也許它是Eclipse的舊版本。 – jonS90

它可以使用Annotations完成。

創建一個簡單的註釋類型，如下列：

@Retention(RetentionPolicy.SOURCE) 
@Target(ElementType.LOCAL_VARIABLE) 
@interface LocalVariableDocumentation { 
    String value(); 
}

並使用它在你的本地變量：

@LocalVariableDocumentation("A very important object!") 
Object anImportantObject;

Eclipse將顯示在工具提示中的註釋。

2015-03-09 11:11:24 Elist

偉大的解決方案，爲什麼這個答案不被接受？ – Ced

可能的唯一方法是全局變量。局部變量不能用JavaDoc的註釋。

2016-09-09 11:34:01

只是做一個鏈接到你的本地變量

String someLocalVariable; 
/** 
* This a local variable: {@link #someLocalVariable} 
*/

2016-11-04 23:37:27

這不適用於Eclipse Mars，是嗎？ – Ced

回答