鍍金池/ 問(wèn)答/Java/ 關(guān)于怎么寫(xiě)好的注釋有什么比較好的經(jīng)驗(yàn)嗎?

關(guān)于怎么寫(xiě)好的注釋有什么比較好的經(jīng)驗(yàn)嗎?

背景:
目前做一個(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ě)注釋?zhuān)瑢?xiě)了注釋也是廢話(huà)

但對(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 返回用戶(hù)信息
     * @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)的廢話(huà),掩飾了真正的代碼意圖。能夠快速的人知道代碼的真正意圖

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

回答
編輯回答
不討囍

我們公司統(tǒng)一使用“阿里編碼規(guī)約”插件,如果沒(méi)有寫(xiě)注釋?zhuān)琁DE就會(huì)提示并給出demo示例告訴你要怎么寫(xiě)注釋?zhuān)怀酥猓€有很多其他的代碼規(guī)范提示,你們可以嘗試一下統(tǒng)一使用這個(gè)插件。
安裝教程:【https://blog.csdn.net/fuzhong...

clipboard.png

2017年6月18日 18:12
編輯回答
朕略傻

我認(rèn)為編寫(xiě)注釋的話(huà)需要團(tuán)隊(duì)有一套標(biāo)準(zhǔn),然后就要靠每個(gè)人的自覺(jué)的。

2018年5月15日 05:57
編輯回答
放開(kāi)她

我認(rèn)為,注釋不是代碼的 再解釋?zhuān)绻f(shuō)注釋很復(fù)雜,那么你的代碼就很有可能有問(wèn)題了
寫(xiě) 一手好的注釋 很像 寫(xiě)簡(jiǎn)歷(個(gè)人想法) 我 需要 什么,我目的是什么,我在在 某些場(chǎng)合下 要完成 怎樣的事情,什么事情是必須做的,什么是一定不能做的,能過(guò)寫(xiě)一手漂亮的注釋 我認(rèn)為比 不會(huì)比寫(xiě)一手漂亮的代碼簡(jiǎn)單

2018年3月6日 17:46