2010-02-21 25 views
2

我注意到,在Eclipse,當我使用/*和/ **爲javadoc - 只是Eclipse還是這是一個Java約定?

/* 
* My Comment 
*/ 
public class myClass { 

} 

「我的評論」 不與類關聯,但

/** 
* My Comment 
*/ 
public class myClass { 

} 

「我的評論」 確實

同樣

/** myComment */ 
public static final String MY_VARIABLE = "testing"; 

也與javadoc相關聯。

這是一個Eclipse的東西或Java記錄系統的一部分。

我應該總是使用/ **而不是/ *嗎?

回答

1
/* My Comment */ is usually used for making a comment block. 

/** MyComment */ is usually used for documentation purposes, such as desribing variables and things like that. 
3

這是如何Javadocs想要的評論和Javadoc是事實上的行業標準。 (Sun's How to write Doc Comments)如doxygen的

其他工具也支持的Javadoc風格,所以你應該總是使用/**徵求意見Java進行開發,除非有很好的理由,當記錄類,方法或變量。對於一般意見,應使用/*

相關問題