整理 Effective Java 書中 Item 56: Write doc comments for all exposed API elements 心得筆記

主旨

寫 Java 程式時，若要讓 API 好用、好維護，註解文件不可或缺。Java 提供的 JavaDoc 工具讓我們能直接從原始碼產生 API 文件，但前提是你要在類別、方法、欄位前寫好符合格式的「doc comment」。本篇說明該怎麼寫註解才真正有幫助，該注意的格式細節與常見錯誤。