編程開發(fā)中的命名規(guī)范

• 混亂的workspace
• • 修改項目名稱
  • 學(xué)習(xí)資料

混亂的workspace

工作一年當(dāng)中接觸到的都是別人寫好的項目，很多時候就直接用了以前的項目名字，隨著手里的項目越來越多，各種版本的項目用著相同的名字，根本記不住哪個項目是做什么的，一片混亂。這時候同事勸我整理一下項目吧，我才意識到這個問題。

修改項目名稱

我做的項目中很多是一套項目改成各種版本給不同的公司用戶使用，所以我試著用“客戶公司名_項目名稱“的方式來修改我的項目名稱，這樣一個系列的就會排列在一起方便查找，這是我目前能想的方法。下面是我修改完名字遇到的問題和解決方法：

問題： 已經(jīng)在使用的項目，修改名稱后導(dǎo)致訪問路徑改變，不方便客戶使用（因為能要求客戶換成新的訪問地址，還存在其他程序訪問該程序時，路徑改變還要修改程序重新上線）。
解決： 1）本地啟動的項目：修改項目配置，無論項目名稱是什么，修改Context root 即可修改更改項目訪問的url路徑。

解決： 1）打成war包上線的項目：修改war的名字即可，此時和Context root的名字已經(jīng)無關(guān)了。

學(xué)習(xí)資料

雖然大學(xué)中學(xué)習(xí)過，但是很多都已經(jīng)忘記了，下面是我在網(wǎng)上查找的命名規(guī)范，供自己學(xué)習(xí)使用：

數(shù)據(jù)庫命名設(shè)計規(guī)范：
1）.數(shù)據(jù)庫涉及字符規(guī)范

采用26個英文字母(區(qū)分大小寫)和0-9這十個自然數(shù),加上下劃線’_'組成,共63個字符.不能出現(xiàn)其他字符(注釋除外)。

注意事項:

1)以上命名都不得超過30個字符的系統(tǒng)限制.變量名的長度限制為29(不包括標(biāo)識字符@)。

2)數(shù)據(jù)對象、變量的命名都采用英文字符,禁止使用中文命名.絕對不要在對象名的字符之間留空格.。

3)小心保留詞,要保證你的字段名沒有和保留詞、數(shù)據(jù)庫系統(tǒng)或者常用訪問方法沖突 。

4)保持字段名和類型的一致性,在命名字段并為其指定數(shù)據(jù)類型的時候一定要保證一致性.假如數(shù)據(jù)類型在一個表里是整數(shù),那在另一個表里可就別變成字符型了。

2.數(shù)據(jù)庫命名規(guī)范

數(shù)據(jù)庫直接使用應(yīng)用或者系統(tǒng)命名.

比如:paper(論文系統(tǒng))

備份數(shù)據(jù)庫名使用正式庫名加上備份時間組成,

paper_20070403

3.數(shù)據(jù)庫表命名規(guī)范

數(shù)據(jù)表名使用小寫英文以及下劃線組成,盡量說明是那個應(yīng)用或者系統(tǒng)在使用的.（便于區(qū)分不同一個項目使用同一個數(shù)據(jù)庫中的表）

相關(guān)應(yīng)用的數(shù)據(jù)表使用同一前綴,如論壇的表使用cdb_前綴,博客的數(shù)據(jù)表使用supe_前綴,前綴名稱一般不超過5字

paper_user paper_group paper_userspace

備份數(shù)據(jù)表名使用正式表名加上備份時間組成

paper_user_20070403paper_group_20070403 paper_userspace_20070403

4.字段命名規(guī)范

字段名稱一般采用名詞或動賓短語，且字段名為小寫，數(shù)據(jù)庫字段名全部采用小寫英文單詞，單詞之間用“_”隔開，字段名根據(jù)實際意義命名，

注意事項：給所有字段名加注釋

如：sex(性別) is_good(是否優(yōu)秀)

外鍵情況下采用 "表名_id“的方式，

如：user_id(關(guān)聯(lián)用戶表的id)

Java項目命名規(guī)范：
一、命名規(guī)范
1、 項目名全部小寫

2、 包名全部小寫

3、 類名首字母大寫，如果類名由多個單詞組成，每個單詞的首字母都要大寫。

public class MyFirstClass{}

4、 變量名、方法名首字母小寫，如果名稱由多個單詞組成，每個單詞的首字母都要大寫。

int index=0;public void toString(){}

5、 常量名全部大寫

public static final String GAME_COLOR=”RED”;

6、所有命名規(guī)則必須遵循以下規(guī)則：

1)、名稱只能由字母、數(shù)字、下劃線、$符號組成

2)、不能以數(shù)字開頭

3)、名稱不能使用JAVA中的關(guān)鍵字。

4)、堅決不允許出現(xiàn)中文及拼音命名。

原文鏈接：https://blog.csdn.net/qq_30021219/article/details/79423124

二、注釋規(guī)范

1、 類注釋

在每個類前面必須加上類注釋，注釋模板如下：

/*** Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.* FileName: Test.java* 類的詳細(xì)說明** @author 類創(chuàng)建者姓名 * @Date 創(chuàng)建日期* @version 1.00*/

2、 屬性注釋

在每個屬性前面必須加上屬性注釋，注釋模板如下：

/** 提示信息 */private String strMsg = null;

3、 方法注釋

在每個方法前面必須加上方法注釋，注釋模板如下：

/*** 類方法的詳細(xì)使用說明** @param 參數(shù)1 參數(shù)1的使用說明* @return 返回結(jié)果的說明* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明*/

4、 構(gòu)造方法注釋

在每個構(gòu)造方法前面必須加上注釋，注釋模板如下：

/*** 構(gòu)造方法的詳細(xì)使用說明** @param 參數(shù)1 參數(shù)1的使用說明* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明*/

5、 方法內(nèi)部注釋

在方法內(nèi)部使用單行或者多行注釋，該注釋根據(jù)實際情況添加。

如：//背景顏色

Color bgColor = Color.RED

原文鏈接：https://www.php.cn/java-article-406664.html

Java包起名原則：
indi ：
個體項目，指個人發(fā)起，但非自己獨自完成的項目，可公開或私有項目，copyright主要屬于發(fā)起者。
包名為“indi.發(fā)起者名.項目名.模塊名.……”。

pers ：
個人項目，指個人發(fā)起，獨自完成，可分享的項目，copyright主要屬于個人。
包名為“pers.個人名.項目名.模塊名.……”。

priv ：
私有項目，指個人發(fā)起，獨自完成，非公開的私人使用的項目，copyright屬于個人。
包名為“priv.個人名.項目名.模塊名.……”。

onem ：
與“indi”相同，推薦使用“indi”。
另外，我為了區(qū)分團(tuán)隊項目和前面所說項目的區(qū)分，還有了一下擴(kuò)展：

team ：
團(tuán)隊項目，指由團(tuán)隊發(fā)起，并由該團(tuán)隊開發(fā)的項目，copyright屬于該團(tuán)隊所有。
包名為“team.團(tuán)隊名.項目名.模塊名.……”。

com ：
公司項目，copyright由項目發(fā)起的公司所有。
包名為“com.公司名.項目名.模塊名.……”。

java包各模塊命名規(guī)則
action為控制層：有時也會命名為“controller”即MVC中充當(dāng)C角色,用來分配哪個業(yè)務(wù)來處理用戶請求。

biz業(yè)務(wù)層：存放好多處理業(yè)務(wù)的代碼，現(xiàn)實中面向接口編程，一般這里定義都是業(yè)務(wù)接口，通常會有一個biz.impl這個包用來寫實現(xiàn)類. 當(dāng)然針對架構(gòu)意義實現(xiàn)類不用說。

dao持久層：數(shù)據(jù)庫操作都寫在這里。

ui 用戶交互層：通常為頁面,例如.jsp,aspx等頁面。

util功能包：針對本項目工具類。

common通用工具包：一般一個公司會有固定的jar，好幾個項目通用的，例如遠(yuǎn)程調(diào)用等。

domian存放實體：通常一些對應(yīng)數(shù)據(jù)表的實體類放在此，如果用Mybatis框架,一般mapping創(chuàng)建在它下面,當(dāng)然只針對架構(gòu)mapping也是無意義。

良好的命名規(guī)則能夠讓他人更容易熟悉項目?？梢詭椭约嚎焖倩仡櫞a。好處多多。

原文鏈接：http://blog.csdn.net/Dave_CT/article/details/73394726

總結(jié)

以上是生活随笔為你收集整理的编程开发中的起名规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。