欧美成人午夜免费全部完,亚洲午夜福利精品久久,а√最新版在线天堂,另类亚洲综合区图片小说区,亚洲欧美日韩精品色xxx

扣丁學(xué)堂Java培訓(xùn)分享阿里巴巴Java網(wǎng)頁版開發(fā)手冊

2018-09-11 17:38:10 1269瀏覽

大家不論是參加Java培訓(xùn)還是學(xué)習(xí)別的開發(fā)語言，其最終的目的多數(shù)都是想要找到一份高薪的好工作就業(yè)，那么阿里巴巴企業(yè)應(yīng)該是不少人心目中的理想企業(yè)了，相信也有不少的小伙伴很想進(jìn)去阿里巴巴去工作，本篇文章扣丁學(xué)堂Java培訓(xùn)小編就和大家來分享一下阿里巴巴Java網(wǎng)頁版開發(fā)手冊-注釋規(guī)約，希望對小伙伴們有所幫助。

1、【強(qiáng)制】類、類屬性、類方法的注釋必須使用 Javadoc 規(guī)范，使用/**內(nèi)容*/格式，不得使用// xxx 方式。

說明：在IDE 編輯窗口中， Javadoc方式會提示相關(guān)注釋，生成Javadoc可以正確輸出相應(yīng)注釋; 在IDE中，工程調(diào)用方法時，不進(jìn)入方法即可懸浮提示方法、參數(shù)、返回值的意義，提高閱讀效率。

2、【強(qiáng)制】所有的類都必須添加創(chuàng)建者和創(chuàng)建日期。

3、【強(qiáng)制】所有的抽象方法 ( 包括接口中的方法 ) 必須要用Javadoc注釋、除了返回值、參數(shù)、異常說明外，還必須指出該方法做什么事情，實現(xiàn)什么功能。

說明：對子類的實現(xiàn)要求，或者調(diào)用注意事項，請一并說明。

4、【強(qiáng)制】所有的枚舉類型字段必須要有注釋，說明每個數(shù)據(jù)項的用途。

5、【推薦】與其“半吊子”英文來注釋，不如用中文注釋把問題說清楚。專有名詞與關(guān)鍵字保持英文原文即可。

反例：“ TCP 連接超時”解釋成“傳輸控制協(xié)議連接超時”，理解反而費腦筋。

6、【強(qiáng)制】方法內(nèi)部單行注釋，在被注釋語句上方另起一行，使用//注釋。方法內(nèi)部多行注釋使用/* */注釋，注意與代碼對齊。

7、【參考】合理處理注釋掉的代碼。在上方詳細(xì)說明，而不是簡單的注釋掉。如果無用，則刪除。

說明：代碼被注釋掉有兩種可能性：1 ) 后續(xù)會恢復(fù)此段代碼邏輯。2 ) 永久不用。前者如果沒有備注信息，難以知曉注釋動機(jī)。后者建議直接刪掉 ( 代碼倉庫保存了歷史代碼 )

8、【參考】對于注釋的要求：第一、能夠準(zhǔn)確反應(yīng)設(shè)計思想和代碼邏輯;第二、能夠描述業(yè)務(wù)含義，使別的程序員能夠迅速了解到代碼背后的信息。完全沒有注釋的大段代碼對于閱讀者形同天書，注釋是給自己看的，即使隔很長時間，也能清晰理解當(dāng)時的思路;注釋也是給繼任者看的，使其能夠快速接替自己的工作。

9、【推薦】代碼修改的同時，注釋也要進(jìn)行相應(yīng)的修改，尤其是參數(shù)、返回值、異常、核心邏輯等的修改。

說明：代碼與注釋更新不同步，就像路網(wǎng)與導(dǎo)航軟件更新不同步一樣，如果導(dǎo)航軟件嚴(yán)重滯后，就失去了導(dǎo)航的意義。

10、【參考】好的命名、代碼結(jié)構(gòu)是自解釋的，注釋力求精簡準(zhǔn)確、表達(dá)到位。避免出現(xiàn)注釋的一個極端：過多過濫的注釋，代碼的邏輯一旦修改，修改注釋是相當(dāng)大的負(fù)擔(dān)。

11、【參考】特殊注釋標(biāo)記，請注明標(biāo)記人與標(biāo)記時間。注意及時處理這些標(biāo)記，通過標(biāo)記掃描，經(jīng)常清理此類標(biāo)記。線上故障有時候就是來源于這些標(biāo)記處的代碼。

1 ) 待辦事宜 (TODO) ：( 標(biāo)記人，標(biāo)記時間， [ 預(yù)計處理時間])表示需要實現(xiàn)，但目前還未實現(xiàn)的功能。這實際上是一個Javadoc的標(biāo)簽，目前的Javadoc還沒有實現(xiàn)，但已經(jīng)被廣泛使用。只能應(yīng)用于類，接口和方法 ( 因為它是一個Javadoc 標(biāo)簽 )。

2 ) 錯誤，不能工作 (FIXME) ：( 標(biāo)記人，標(biāo)記時間， [ 預(yù)計處理時間])。

在注釋中用FIXME 標(biāo)記某代碼是錯誤的，而且不能工作，需要及時糾正的情況。

想要了解更多關(guān)于Java開發(fā)方面內(nèi)容的小伙伴，請關(guān)注扣丁學(xué)堂Java培訓(xùn)官網(wǎng)、微信等平臺，扣丁學(xué)堂IT職業(yè)在線學(xué)習(xí)教育平臺為您提供權(quán)威的Java開發(fā)環(huán)境搭建視頻，Java培訓(xùn)后的前景無限，行業(yè)薪資和未來的發(fā)展會越來越好的，通過千鋒扣丁學(xué)堂金牌講師在線錄制的Java開發(fā)教程，讓你快速掌握Java從入門到精通開發(fā)實戰(zhàn)技能?？鄱W(xué)堂Java技術(shù)交流群：670348138。

【關(guān)注微信公眾號獲取更多學(xué)習(xí)資料】

查看更多關(guān)于“Java開發(fā)資訊”的相關(guān)文章>>