背景:目前做一個Java的服務端項目,要求所有Controller,Service,Dao,Entity都需要用標準的Javadoc寫注釋 @Controller public class LoginController{ @RequestMapping(value = "/login") public void login(String account, String password){ } } 自己覺得對于上面這種方法，一眼就能看出在做什么的，根本不需要寫注釋，寫了注釋也是廢話 但對于整個項目來說,卻需要我們將整個代碼寫成下面這樣 /** * 登錄相關的業務接口 * @author xxx * */ public interface LoginService{ /** * 登錄 * @param account 賬號 * @param password 密碼 * @return 返回用戶信息 * @author xxx */ User login(String account, String password); } 如果整個項目都遵循規范也無可厚非。但大多時候，我們只維護了代碼，卻沒有去維護注釋，導致注釋成了誤解 所以很多時候，我都會有一種疑惑，怎么去寫恰到好處的注釋，不讓注釋成為顯而易見的廢話，掩飾了真正的代碼意圖。能夠快速的人知道代碼的真正意圖 各位有什么好的經驗，方法和技巧可以分享嗎？