Java項(xiàng)目命名規(guī)范參考
一、項(xiàng)目名
所有單詞全部用小寫(xiě),如testjavaproject、studentmanagement等
二、包名
全部小寫(xiě),名詞。如:java.awt.event。
三、類名、接口名
首字母大寫(xiě),多個(gè)單詞組成時(shí),每個(gè)單詞的首字母大寫(xiě)。如:
public class MyClass {}
四、方法名
首字母小寫(xiě),多個(gè)單詞組成時(shí),從第二個(gè)單詞開(kāi)始,每個(gè)單詞的首字母大寫(xiě)。第一個(gè)單詞一般為動(dòng)詞,如:
public void toString() {}
五、變量名
一、普通變量名
同方法的命名,一般為名詞。如:
int index=0;
二、常量名(靜態(tài)變量名)
全部大寫(xiě)。如:
public static final String GAME_COLOR=”RED”;
六、屬性文件properties
以下劃線隔開(kāi)。如:errors_zh_CN.properties,hibernate_test.properties
七、數(shù)據(jù)庫(kù)命名:
表、字段命名全部大寫(xiě),多個(gè)單詞以_隔開(kāi)
八、注釋規(guī)范
一、類注釋
在每個(gè)類前面必須加上類注釋,注釋模板如下:
/** * Copyright (C), 2006-2010, Anhui Love info. Co., Ltd. * FileName: Test.java * 類的詳細(xì)說(shuō)明 * * @author 類創(chuàng)建者姓名 * @Date 創(chuàng)建日期 * @version 1.00 */
二、屬性注釋
在每個(gè)屬性前面必須加上屬性注釋,注釋模板如下:
/** 提示信息 */ private String strMsg = null;
三、方法注釋
在每個(gè)方法前面必須加上方法注釋,注釋模板如下:
/** * 類方法的詳細(xì)使用說(shuō)明 * * @param 參數(shù)1 參數(shù)1的使用說(shuō)明 * @return 返回結(jié)果的說(shuō)明 * @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說(shuō)明 */
四、構(gòu)造方法注釋
在每個(gè)構(gòu)造方法前面必須加上注釋,注釋模板如下:
/** * 構(gòu)造方法的詳細(xì)使用說(shuō)明 * * @param 參數(shù)1 參數(shù)1的使用說(shuō)明 * @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說(shuō)明 */
五、方法內(nèi)部注釋
在方法內(nèi)部使用單行或者多行注釋,該注釋根據(jù)實(shí)際情況添加。如:
//背景顏色 Color bgColor = Color.RED
重點(diǎn)
類名不能是關(guān)鍵字
關(guān)鍵字不能用于變量名、方法名、類名、包名
1)、名稱只能由字母、數(shù)字、下劃線、$符號(hào)組成
2)、不能以數(shù)字開(kāi)頭
3)、名稱不能使用JAVA中的關(guān)鍵字。
4)、堅(jiān)決不允許出現(xiàn)中文及拼音命名。
參考文章的連接如下:
https://blog.csdn.net/chao2016/article/details/79370658
https://www.cnblogs.com/superfly123/p/10446805.html
到此這篇關(guān)于Java項(xiàng)目命名規(guī)范參考的文章就介紹到這了,更多相關(guān)Java 命名規(guī)范內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Struts攔截器實(shí)現(xiàn)攔截未登陸用戶實(shí)例解析
這篇文章主要介紹了Struts攔截器實(shí)現(xiàn)攔截未登陸用戶實(shí)例解析,分享了相關(guān)代碼示例,小編覺(jué)得還是挺不錯(cuò)的,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-02-02基于spring+springmvc+hibernate 整合深入剖析
這篇文章主要介紹了于spring+springmvc+hibernate整合實(shí)例,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-10-10SpringBoot集成Spring Security用JWT令牌實(shí)現(xiàn)登錄和鑒權(quán)的方法
這篇文章主要介紹了SpringBoot集成Spring Security用JWT令牌實(shí)現(xiàn)登錄和鑒權(quán)的方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-05-05SpringCloud如何引用xxjob定時(shí)任務(wù)
Spring?Cloud?本身不直接支持?XXL-JOB?這樣的定時(shí)任務(wù)框架,如果你想在?Spring?Cloud?應(yīng)用中集成?XXL-JOB,你需要手動(dòng)進(jìn)行配置,本文給大家介紹SpringCloud如何引用xxjob定時(shí)任務(wù),感興趣的朋友一起看看吧2024-04-04SpringMVC @ResponseBody 415錯(cuò)誤處理方式
這篇文章主要介紹了SpringMVC @ResponseBody 415錯(cuò)誤處理方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11Springboot @Value獲取值為空問(wèn)題解決方案
這篇文章主要介紹了Springboot @Value獲取值為空問(wèn)題解決方案,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02