背景:
目前做一個(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...】
北大青鳥(niǎo)APTECH成立于1999年。依托北京大學(xué)優(yōu)質(zhì)雄厚的教育資源和背景,秉承“教育改變生活”的發(fā)展理念,致力于培養(yǎng)中國(guó)IT技能型緊缺人才,是大數(shù)據(jù)專(zhuān)業(yè)的國(guó)家
北大青鳥(niǎo)中博軟件學(xué)院創(chuàng)立于2003年,作為華東區(qū)著名互聯(lián)網(wǎng)學(xué)院和江蘇省首批服務(wù)外包人才培訓(xùn)基地,中博成功培育了近30000名軟件工程師走向高薪崗位,合作企業(yè)超4
中公教育集團(tuán)創(chuàng)建于1999年,經(jīng)過(guò)二十年潛心發(fā)展,已由一家北大畢業(yè)生自主創(chuàng)業(yè)的信息技術(shù)與教育服務(wù)機(jī)構(gòu),發(fā)展為教育服務(wù)業(yè)的綜合性企業(yè)集團(tuán),成為集合面授教學(xué)培訓(xùn)、網(wǎng)
達(dá)內(nèi)教育集團(tuán)成立于2002年,是一家由留學(xué)海歸創(chuàng)辦的高端職業(yè)教育培訓(xùn)機(jī)構(gòu),是中國(guó)一站式人才培養(yǎng)平臺(tái)、一站式人才輸送平臺(tái)。2014年4月3日在美國(guó)成功上市,融資1
曾工作于聯(lián)想擔(dān)任系統(tǒng)開(kāi)發(fā)工程師,曾在博彥科技股份有限公司擔(dān)任項(xiàng)目經(jīng)理從事移動(dòng)互聯(lián)網(wǎng)管理及研發(fā)工作,曾創(chuàng)辦藍(lán)懿科技有限責(zé)任公司從事總經(jīng)理職務(wù)負(fù)責(zé)iOS教學(xué)及管理工作。
浪潮集團(tuán)項(xiàng)目經(jīng)理。精通Java與.NET 技術(shù), 熟練的跨平臺(tái)面向?qū)ο箝_(kāi)發(fā)經(jīng)驗(yàn),技術(shù)功底深厚。 授課風(fēng)格 授課風(fēng)格清新自然、條理清晰、主次分明、重點(diǎn)難點(diǎn)突出、引人入勝。
精通HTML5和CSS3;Javascript及主流js庫(kù),具有快速界面開(kāi)發(fā)的能力,對(duì)瀏覽器兼容性、前端性能優(yōu)化等有深入理解。精通網(wǎng)頁(yè)制作和網(wǎng)頁(yè)游戲開(kāi)發(fā)。
具有10 年的Java 企業(yè)應(yīng)用開(kāi)發(fā)經(jīng)驗(yàn)。曾經(jīng)歷任德國(guó)Software AG 技術(shù)顧問(wèn),美國(guó)Dachieve 系統(tǒng)架構(gòu)師,美國(guó)AngelEngineers Inc. 系統(tǒng)架構(gòu)師。