JAVA代碼書寫規(guī)范有哪些,針對這個問題,這篇文章詳細介紹了相對應的分析和解答,希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。
在肥東等地區(qū),都構(gòu)建了全面的區(qū)域性戰(zhàn)略布局,加強發(fā)展的系統(tǒng)性、市場前瞻性、產(chǎn)品創(chuàng)新能力,以專注、極致的服務(wù)理念,為客戶提供成都網(wǎng)站制作、成都網(wǎng)站設(shè)計 網(wǎng)站設(shè)計制作按需策劃設(shè)計,公司網(wǎng)站建設(shè),企業(yè)網(wǎng)站建設(shè),品牌網(wǎng)站建設(shè),成都全網(wǎng)營銷推廣,外貿(mào)網(wǎng)站制作,肥東網(wǎng)站建設(shè)費用合理。
一般原則
盡量使用完整的英文描述符 采用適用于相關(guān)領(lǐng)域的術(shù)語 采用大小寫混合增強可讀性 盡量少用縮寫,但如果用了,要明智地使用,且在整個工程中統(tǒng)一 避免使用長的名字 避免使用類似的名字,或者僅僅是大小寫不同的名字 避免使用下劃線(除靜態(tài)常量等)
命名的字母大小寫問題
包名: 字母全小寫 例如: cn.coderstory.Activity.Main 類,接口 :首字母大寫,其他全小寫 例如: class Container 方法,變量 :第二個單詞開始首字母大寫 例如: seedMessage 常量: 大寫,單詞用“_”分割 例如: final static MIN_WIDTH = 4 接口 :首字母大寫 ,后綴Impl 例如: class ContainerImpl 異常類: 首字母大寫, 后綴Exception 例如: DataNotFoundException 抽象類 :首字母大寫, 前綴Abstract 例如: AbstractBeanDefinition Test類: 首字母大寫, 后綴Test 例如: public Location newLocation()
方法的命名
類中獲取值方法,一般要求被方法名使用被訪問字段名,前面加上前綴get,如getLastUser(), getUserCount() 返回布爾型的判斷方法一般要求方法名使用單詞 is 做前綴,如isPersistent(),isString()。或者使用具有邏輯意義的單詞,例如equal 或equals 用于修改某些設(shè)置的方法(一般返回類型為void):被訪問字段名的前面加上前綴 set,如setFirstName(),setLastName(),setWarpSpeed()。 已辦的方法一般采用完整的英文描述說明成員方法功能,第一個單詞盡可能采用一個生動的動詞,第一個字母小寫,如 openFile(), addAccount()。 接口 :首字母大寫 ,后綴Impl 例如: class ContainerImpl 異常類: 首字母大寫, 后綴Exception 例如: DataNotFoundException 抽象類 :首字母大寫, 前綴Abstract 例如: AbstractBeanDefinition Test類: 首字母大寫, 后綴Test 例如: public Location newLocation()
Java注釋約定
類的整體注釋:遵循JavaDoc的規(guī)范,在每一個源文件的開頭注明該CLASS的作用, 作簡要說明, 并寫上源文件的作者, 編寫日期。如果是修改別人編寫的源文件,要在修改信息上注明修改者和修改日期。
例如:
/*** @(#):CLASSNAME.java* @description: Description of this java* @author: PROGRAMMER'S NAME YYYY/MM/DD* @version: Version No.* @modify:* @Copyright: 版權(quán)由擁有*/
類中方法的注釋:遵循JavaDoc的規(guī)范,在每個方法的前部用塊注釋的方法描述此方法的作用,以及傳入,傳出參數(shù)的類型和作用,以及需要捕獲的錯誤。
例如:
/*** 方法的描述***@param 參數(shù)的描述*@return 返回類型的描述*@exception 出錯信息的描述*/
行注釋:使用//…的注釋方法來注釋需要表明的內(nèi)容。并且把注釋的內(nèi)容放在需要注釋的代碼的前面一行或同一行。 塊注釋:使用/**和*/注釋的方法來注釋需要表明的內(nèi)容。并且把注釋的內(nèi)容放在需要注釋的代碼的前面。 注釋哪些部分:類的目的(即類所完成的功能)、設(shè)置接口的目的以及應如何被使用、成員方法注釋(對于設(shè)置與獲取成員方法,在成員變量已有說明的情況下,可以不加注釋;普通成員方法要求說明完成什么功能,參數(shù)含義是什么?返回什么?)、普通成員方法內(nèi)部注釋(控制結(jié)構(gòu)、代碼做了些什么以及為什么這樣做,處理順序等)、實參和形參的含義以及其他任何約束或前提條件、字段或?qū)傩悦枋觥6鴮τ诰植孔兞浚鐭o特別意義的情況下不加注釋。
JAVA文件聲明順序
類或接口應該按以下順序聲明(其實是加載順序的問題):
包的定義 impot類(輸入包的順序、避免使用*)輸入包應該按照java.*.*,javax.*.*,org.*.* ,com.*.*的順序import在import的時候不應該使用* (例如: java.util.*) 類或接口的定義 靜態(tài)變量定義,按public,protected,private順序 實例變量定義,按public,protected,private順序 構(gòu)造方法 方法定義順序按照public方法(類自己的方法),實現(xiàn)接口的方法,重載的public法,受保護方法,包作用域方法和私有方法。建議:類中每個方法的代碼行數(shù)不要超過100行。 內(nèi)部類的定義
關(guān)于JAVA代碼書寫規(guī)范有哪些問題的解答就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,如果你還有很多疑惑沒有解開,可以關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道了解更多相關(guān)知識。
文章標題:JAVA代碼書寫規(guī)范有哪些
標題鏈接:http://vcdvsql.cn/article34/gjdcpe.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供軟件開發(fā)、動態(tài)網(wǎng)站、網(wǎng)站設(shè)計公司、外貿(mào)建站、自適應網(wǎng)站、品牌網(wǎng)站制作
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)