與doc評論的問題

Question

/** Checks to make sure that the @param ch is not a white space, if so returns true, if not returns false*/ 
public static boolean isWhiteSpace(char ch) 
{ 
    if(ch == ' ') 
     return true; 
    else 
     return false; 
} 

我正在寫文檔評論，並且當我使用@param功能時，它跟隨在我的文檔評論中。這是否應該發生？

Answer 1

是的，這是應該發生的。 @param不是什麼被認爲是block tag，所以它不能放在該部分。

該只有你可以放置的地方@param是在標籤部分。

爲此，避免這樣寫Javadoc。無論如何，你想描述行爲而不是依賴這個變量。

像這樣的事情會更好：

/** Checks to see if the provided argument is a space. 
* @param ch the character passed through 
* @return true if the character is a space, false otherwise. 
*/ 
public boolean isWhiteSpaceChar(char ch) { 
    // impl 
} 

Take a gander at the official style guide更多的情況下進入這個。

Answer 2

我不完全確定你在問什麼。

爲了使Javadoc註釋，你開始做這個：

/** 
* Checks to see if a character contains a whitespace character or not. 
* 
* @param ch Character to check for whitespace 
*/ 

編輯：你平時不是指在描述一個變量，但低於它。