註解

註解，是輔助程式開發者，在維護程式時，可以快速了解該行或該區塊是在做什麼運算，就好像貼一個便利貼，在程式碼中，來提醒未來的自己或他人說明解釋程式碼的功用。另外當程式被註解掉時，編譯器不會把它當程式碼去進行編譯與執行。

老師建議程式碼要有良好的註解，在未來維護上會發揮很大的效用。當然很多學生反應，自己一定記得，當初寫過什麼，為什麼要那樣寫，但實際上可能一個禮拜左右或是兩個禮拜以上，再回來看當初寫的程式碼，就要花很長一段時間，去研究才能弄懂這段和那段在寫什麼，寧願當下註解說明解釋程式碼用途，才不會事後要很多倍的時間去追 code 回憶了解。

注意:以下註解會被javac.exe編譯時忽略。利用反編譯程式將xxx.class --->xxx.java打開看時,會發現所有的註解都不見了

為什麼要註解? 註解是你自己看的或是要給別人運用看的,你不在裡面註解說明寫這個類的細節與用法,改日回頭自己也看不懂,別說他人了...

一般的註解　這是基本的註解給自己看的

//這是一個單行註解	單行註解以 // 為開頭
/* 這是一個多行註解 */	多行註解以 /* 為開頭 / 為結尾*

說明文件的註解 利用javadoc程式幫你的java程式產生使用說明文件。

/ 用來測試產生說明的文件. /*	說明文件的註解以 /** 為開頭 */ 為結尾
/** * This is a sample comment * @auther : ABC * @version 1.0 */	說明文件以HTML標記方式: @參數內容說明文件的註解位置: class(類)、variable(變量) 和 method(方法) 之前。