背景:
目前做一個(gè)Java的服務(wù)端項(xiàng)目,要求所有Controller,Service,Dao,Entity都需要用標(biāo)準(zhǔn)的Javadoc寫(xiě)注釋

@Controller
public class LoginController{
    
    @RequestMapping(value = "/login")
    public void login(String account, String password){
    
    }
    
}

自己覺(jué)得對(duì)于上面這種方法，一眼就能看出在做什么的，根本不需要寫(xiě)注釋，寫(xiě)了注釋也是廢話

但對(duì)于整個(gè)項(xiàng)目來(lái)說(shuō),卻需要我們將整個(gè)代碼寫(xiě)成下面這樣

/**
 * 登錄相關(guān)的業(yè)務(wù)接口
 * @author xxx
 *
 */
public interface LoginService{
    
    /**
     * 登錄
     * @param account 賬號(hào)
     * @param password 密碼  
     * @return 返回用戶信息
     * @author xxx   
     */
    User login(String account, String password);
}

如果整個(gè)項(xiàng)目都遵循規(guī)范也無(wú)可厚非。但大多時(shí)候，我們只維護(hù)了代碼，卻沒(méi)有去維護(hù)注釋，導(dǎo)致注釋成了誤解

所以很多時(shí)候，我都會(huì)有一種疑惑，怎么去寫(xiě)恰到好處的注釋，不讓注釋成為顯而易見(jiàn)的廢話，掩飾了真正的代碼意圖。能夠快速的人知道代碼的真正意圖

各位有什么好的經(jīng)驗(yàn)，方法和技巧可以分享嗎？