小攻城師的戰場筆記

在 Visual Studio，只要在函式 (function) 或類別 (class) 上方按下三次註解符號，就會自動產生一段 XML 格式的註解。填完這段註解後，在輸入函式時就會自動解析 XML 的內容，成為函式或類別使用的提示 (intellisense)。例如說這個函式有三個參數，每個參數應該給什麼格式？給定的參數的代表意義是什麼？如果每次寫新的函式時都能照著寫，日後呼叫函式或使用類別時，就能輕鬆辨識每一段程式碼的應用方式。今天發現在 eclipse 裡也有類似的功能。

完成函式的撰寫之後，輸入「/**」。接著按下 Enter，就會自動帶出後續的輸入提示。以下圖的程式碼為例，因為需要帶進一個參數，所以會自動要你填上參數的用意（寫在 @param 之後）。








填過註解之後，以後在呼叫這段程式碼時，eclipse 會自動帶出函式的說明文字。



 


如果註解寫得夠清楚，以後寫程式就不必一直想 getSession() 這支函式是幹嘛的？餵的 $key 代表什麼？腦容量就可以留給其他事啦～