2015-07-19 115 views
-2

我總是在Java中使用註釋運算符,無論何時需要記錄或解釋函數。/**評論。 */VS/*評論* /在Java中

/* 
* Comment 
*/ 

我也看到有人使用註釋操作這樣

/** 
* Comment. 
*/ 

有趣的是,如果你使用這個註釋操作符,它會顯示@參數,如果你有參數,如果你有一個返回返回: 。

他對我說,我需要在句子結尾放一段時間;那麼,如果您在其他地方使用該函數,則可以將該註釋視爲文檔,如Javadoc。

我不知道如何查看評論作爲文檔。你能告訴我如何在Netbean和Eclipse中顯示它。謝謝 !

+1

這叫做[Javadoc](http://www.oracle.com/technetwork/articles/java/index-jsp-135444.html)。這應該有助於您找到所需的信息。 –

+0

在Eclipse中,您可以使用Window-> Show View-> Javadoc並將光標設置爲任何函數,變量等,您將看到它的javadoc。既適用於您自己的JavaDoc,也適用於閱讀第三方文檔 –

回答

1

你的同事是對的:這是一個Javadoc評論。您可以直接使用Javadoc工具把它變成HTML(然後你就可以用你的瀏覽器中打開),或詢問您的IDE來爲你做它:

0

是的,這是用來記錄功能或類。

/** 
* This function is used to add integer a to integer b. 
* 
* @param this first integer. 
* @param b the second integer 
* @return the addition of a and b 
*/ 
public int add(int a, int b) { 
    return a + b; 
} 

如果您的代碼中的其他位置調用此函數,您將能夠看到評論。 (編輯器自動完成的事件)。