2011-10-24 24 views
1

我很想寫點東西如下:如何識別Javadoc或僞代碼中的實例?

StringBuilder.append(String.format("%d %f", x, y)); 

但是,我知道,我真的與StringBuilder的實例工作,我並不想被調用靜態append方法。是否有寫這種Javadoc或僞代碼的常用方法?

回答

2

我喜歡在這裏寫StringBuilder#append(...)來表示這是一個在StringBuilder實例上調用的實例方法,而不是類(靜態)方法,與類方法String.valueOf(...)形成對比。雖然我不確定這是否有一個明確的約定。

+0

這個問題(和我的答案)是關於在靜態和非靜態成員中使用不同的符號,而不是在Javadoc的'@ see'標記中使用'#'(在靜態和非靜態成員中使用它)。我澄清了我的答案,明確表示了這一點。 –