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