西安劍鋒網(wǎng)絡(luò)-代碼編寫規(guī)范
代碼編寫規(guī)范使用范圍:J2EE項目開發(fā)。
包命名規(guī)范:
目的:包的命名規(guī)范應(yīng)當(dāng)體現(xiàn)出項目資源良好的劃分
servlet類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.servlet
例如:net.linkcn.web.servlet
自定義標(biāo)簽類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.tags
例如:net.linkcn.web.tags
過濾器類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.filter
例如:net.linkcn.web.filter
Action類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.struts.action
例如:net.linkcn.web.struts.action
ActionForm類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.struts.form
例如:net.linkcn.web.struts.form
Javabean所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.struts.service.impl
例如:net.linkcn.web.service.impl
Javabean實現(xiàn)接口命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.web.service
例如:net.linkcn.web.service
DAO類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.dao.impl
例如:net.linkcn.dao.impl
DAO類所實現(xiàn)的接口在包中命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.dao
例如:net.linkcn.dao
POJO類與hbm文件所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.dao.hbm
例如:net.linkcn.dao.hbm
全局公共類、接口類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.global
例如:net.linkcn.global
全局工具類所在包命名規(guī)范:公司名稱.開發(fā)組名稱.項目名稱.util
例如:net.linkcn.util
類命名規(guī)范
基本命名規(guī)范:
類、接口命名
命名規(guī)范:以大寫字母開頭,如果有多個單詞,每個單詞頭字母大寫
例如:StudentInfo
接口命名
命名規(guī)范:以大寫字母"I"開頭,如果有多個單詞,每個單詞頭字母大寫
例如:IStudentInfo
接口實現(xiàn)類命名:
命名規(guī)范:將實現(xiàn)的接口名稱的首字母"I"去掉,以"Impl作為結(jié)尾",如果有多個單詞,每個單詞頭字母大寫。
例如:StudentInfoImpl
J2EE+SSH框架命名規(guī)范
servlet類命名:
命名規(guī)范:以Servlet單詞結(jié)尾
例如:LoginServlet
POJO命名:
使用hibernate自動生成的類即可
DAO類命名:
使用hibernate自動生成的類即可
Action類命名:
命名規(guī)范:Action的命名以POJO名稱來制定,POJO名稱Action
例如:
一個POJO名稱為Diary,其對應(yīng)的action為DiaryAction
ActionForm類命名:
命名規(guī)范:ActionForm的命名以POJO名稱來制定,POJO名稱Form
例如:
一個POJO名稱為Diary,其對應(yīng)的actioForm為DiaryForm
業(yè)務(wù)邏輯接口命名:
命名規(guī)范:業(yè)務(wù)邏輯接口的命名以POJO名稱來制定,IPOJO名稱Service
例如:
一個POJO名稱為Diary,其對應(yīng)的業(yè)務(wù)邏輯接口為IDiaryService
業(yè)務(wù)邏輯實現(xiàn)類命名:
命名規(guī)范:業(yè)務(wù)邏輯接口實現(xiàn)類的命名以POJO名稱來制定
例如:
一個POJO名稱為Diary,對應(yīng)的業(yè)務(wù)邏輯接口實現(xiàn)類名為DiaryServiceImpl
類變量命名:
命名規(guī)范:變量名首字母必須小寫,如果該變量名有多個單詞組成,后面的單 詞首字母大寫,單詞與單詞之間不要使用"_"做連接,變量名訪問控制必須為私有, 可以對其增加setter與getter方法。
例如:private int studentAge;
public int getStudentAge()
{
return studentAge;
}
public void setStudentAge(int studentAge)
{
this.studentAge=studentAge;
}
常量命名:
命名規(guī)范:所有字母大寫,如果有多個單詞組成,單詞與單詞之間以” _“隔開。而 且該變量必須是公共、靜態(tài)、final類型
例如:public static final String USER_NAME=”userName“;
方法命名
命名規(guī)范:首字母必須小寫,如果該變量名有多個單詞組成,后面的單詞首字母 大寫,單詞與單詞之間不要使用"_"做連接。單詞不要使用名詞。
例如:public int checkLogin(String name,String pwd){}
注釋規(guī)范:注釋規(guī)范是整個開發(fā)規(guī)范中最為重要的組成部分,必須嚴(yán)格執(zhí)行。
類的注釋:
作用:注釋整個類,簡單概述該類作用。
書寫規(guī)范:類的注釋必須寫在該類的聲明語法之前。在注釋中要描述該類的基 本作用,作者,日期,版本,公司名稱,版權(quán)聲明。
格式:
/* *
* 類功能描述:(大致描述類的功能)
* @author:編寫者名稱
*
* @version: 類文件的版本號 從1.0開始(自己確定版本號的增改
* 情況), 修改情況(修改時間、作者、改動情況)
*
* @see 包名.參考類名 (列出父類,引入類,每個類占一行),如果有
* 可省略
* 相關(guān)數(shù)據(jù)如:(便于理解本類的一些常量數(shù)據(jù)及某些數(shù)據(jù)的格式
* 或認(rèn)為比較重要的數(shù)據(jù),如果沒有可省略)
*/
相關(guān)文章:
-
蒲城,我的故鄉(xiāng),西安蟠龍網(wǎng)絡(luò)科技有限公司蒲城分公司為蒲城的互聯(lián)網(wǎng)發(fā)展貢獻(xiàn)自己的一份力量!為蒲城的中小企業(yè)發(fā)展提供一份性價比高的網(wǎng)絡(luò)營銷策劃方案!...
-
智能手機(jī)和平板電腦的普及,產(chǎn)生了越來越多的移動端客戶流量,盡管基于手機(jī)和平板電腦的網(wǎng)絡(luò)瀏覽器種類繁多,功能也都越來越完善,但限于較小的終端屏幕以及網(wǎng)絡(luò)流量的問題,移動設(shè)備...
-
Wordpress作為一款可在Windows與Linux環(huán)境下運行的PHP內(nèi)容管理系統(tǒng)軟件,因其功能強(qiáng)大、插件豐富易于擴(kuò)展、主題模板不計其數(shù)而成為目前世界上使用最為廣泛的博客系統(tǒng)。許多個人與企業(yè)都會選擇...
-
怎樣才能讓你的網(wǎng)站脫穎而出呢?在網(wǎng)絡(luò)信息的虛擬世界里,互聯(lián)網(wǎng)提供了天下大同的機(jī)會,同時也讓這個虛擬世界充斥著數(shù)不清的商業(yè)站點、垃圾站點,大多數(shù)站點缺乏靈魂、主旨,松散、...
-
在SEO優(yōu)化中,很多站長都會有一個問題,就是關(guān)于網(wǎng)站地圖。那么,在網(wǎng)站建設(shè)中,網(wǎng)站地圖有什么用呢?而它對排名又有什么影響呢?西安網(wǎng)站建設(shè)推薦閱讀 西安網(wǎng)站建設(shè):企業(yè)網(wǎng)站怎么體...
-
在互聯(lián)網(wǎng)精致那個如此激烈的今天,很多企業(yè)都有了自己的網(wǎng)站。因此,不少企業(yè)為了提高自己的競爭優(yōu)勢,對網(wǎng)站的用戶體驗進(jìn)行完善。那么,要注意哪些地方才能增強(qiáng)用戶體驗?zāi)兀?第一,...
-
百度競價推廣關(guān)鍵詞分組是競價單元的知識點,但是西安劍鋒網(wǎng)絡(luò)認(rèn)為是什么知識點并不重要,重要的是我們是否將這些關(guān)鍵詞展示到想要的排名,并且減少點擊費用。 對于競價推廣關(guān)鍵詞從...
-
對于絕大多數(shù)地方網(wǎng)站來說,最容易賺錢的時代已經(jīng)過去了,去年成為了一個最明顯的分水嶺。營收的難以圖片,表面上是行業(yè)形勢的巨變,但在這些表象背后,站長們更多的把責(zé)任推給下滑...
-
良好的用戶體驗,不但能夠得到搜索引擎的喜歡,還能給網(wǎng)站帶來一大批的死忠粉。這樣看來,用戶體驗在網(wǎng)站建設(shè)中有著十分重要的作用。那么,怎么去提高用戶體驗度呢? 1、布局簡單大氣...
-
競價推廣設(shè)置賬戶啊、建立單元計劃、關(guān)鍵詞選擇等都會設(shè)計到核心關(guān)鍵詞的挖掘。下面,劍鋒網(wǎng)絡(luò)來說說,競價推廣挖掘核心關(guān)鍵詞要注意什么。西安網(wǎng)站建設(shè)推薦閱讀 西安競價托管...