[精讚] [會員登入]
132

程式、函數、資料庫命名的風格

程式或資料庫自己定義統一的命名規則,可以防止因為一個拚字的錯誤花了半個小時來找,也可說是提升工作效率的關鍵。

此文完整連結 http://n.sfs.tw/12242

複製連結 程式、函數、資料庫命名的風格@新精讚
(文章歡迎轉載,務必尊重版權註明連結來源)
2018-03-10 14:24:56 最後編修
2018-03-10 14:23:17 By 瘦河馬
 

自己的程式演進好幾代,每代的命名方法都不一致,是該統一一下程式的命名方法,

話說世界上沒有統一的寫法,只有建議的寫法,所以沒有對錯也沒有好壞的問題,至於理由是我自己掰的~~

基本的原則就是 

  1 命名要達意,不要太長(反正有namespace,要重覆的機率真的很低) 

  2 命名是給自己看得懂為主,不是拿來炫耀的(有什麼好炫耀的?)

  3.容易看錯的字符如 0oO, 1ilI, Pp9qg 要避免混用,要用最好是全英文或全數字組合,以免給自己找麻煩。

每個設計者都有自己的命名方式,有人用的是破爛不堪的英文(還拚錯)(還從頭用到尾),後面看的人簡直是眼睛都快瞎了,要取代又怕「受傷害」。就別說別人了,連自己寫的程式命名的都會有後面打前面的情況,例如開發專案時前面用的是camelCased用到後面變 camel_cased也常發生,一下大寫一下小寫一下縮寫,除了自己看不爽外,想改又很吃力。越大的專案到後面想改都要有很大的決心才敢動手。

我覺得匈牙利命名法不錯(CamelCased),可惜多人不採用。不論如何,自己定義統一的命名規則,可以防止因為一個拚字的錯誤花了半個小時來找,也可說是提升工作效率的關鍵。

程式內文

變數 採用全小寫單名或加底線複名,變數只要懂意義就好,不要混淆即可,寫太長程式不好讀不會比較厲害:

  single, veriable_name

函數或方法    函數最好是以動詞開頭,使用這種型式和變數分開易於辨視,和系統的不一樣能一看就知道是自寫函數,不然像[1]一樣的建議中函數是寫成這樣 call_some_method(this_is_value1, this_is_value2) 寫的長不拉機的。因此我採用 camelcased 型式不加底線首字不大寫以動詞開頭

  function doSomeJobs(), function isUserExisted()

類別 採用首字大寫加底線或加上形識別類型型式:

  class Auth_model , class Auth

檔名 統一全小寫加底線,檔名還是有分大小寫:

  auth_model.php, mylibrary.py

樣版 樣版名我的使用習慣就是首字大寫用 camelcased 的型式:理由就是用習慣了而已:

  IndexRight.php

常數 全大寫加底線,這幾乎是國際慣例了,大家都這樣用

  ASS_HOLE, WHATTHEFA

 

資料庫

資料庫名 採用單名或加底線複名,全小寫:

  note, note_old

資料表名 採單名或加底線複名,全小寫,第一個部分是群組名,MYSQL對資料表有分大小寫

  aurh_role_mng ,其中auth是群組名

欄位名 採複名大小寫混用,因為MYSQL不分欄位的大小寫。如果是敘述性的用底線:

  column_name,  createdDT

  註:MySQL 限制資料表名稱只能有 64 個字元

 

網頁

CSS類別名 採單名,全小寫不加底線,最後一節為標籤類型:

  class="managediv" 或 class="shoptable"

id 採單名或加底線複名,全小寫:

  id="id_name", id="thisisabook"


 

結論

一、只用全小寫單名:CSS類別名

二、採用 camelcased 型式無底線,首字不大寫,以動詞開頭 function doSomeJobs():函數或方法

三、全大寫可加底線:常數

四、採用首字大寫加底線或首字大寫:類別

五、首字大寫用 camelcased 的型式:樣板

六、採複名大小寫混用:資料庫欄位名

其餘全是全小寫單名或加底線複名(single或veriable_name 型式)。
 

參考資料

[1] http://www.codeigniter.org.tw/user_guide/general/styleguide.html#class_and_method_naming


原文 2013-11-01 21:05:38

你可能感興趣的文章

看懂DSUB DVI HDMI USB等各式影音接頭 看懂DSUB DVI HDMI等各式影音接頭

使用Google尋找你的手機 這近發現google竟然可以用來找android的手機,而且不需要經過什麼設定或安裝軟體。

2016 網頁設計的8項觀念 我觀察了這近網頁設計的趨勢,寫出8點設計上應該要注意的給大家參考

台灣佳光(台數科)、群健有線寬頻使用心得 我的台灣佳光(已改名台數科)、群健有線(TBC)'、中華電光世代ADSL、企業專線寬頻使用心得(台中)

銅網路線路UTP測試名詞解釋 一條銅網路線的品質好不好得經過測試,測試也是有學問的

程式、函數、資料庫命名的風格 程式或資料庫自己定義統一的命名規則,可以防止因為一個拚字的錯誤花了半個小時來找,也可說是提升工作效率的關鍵。

HP SAS硬碟leds燈號說明 HP SAS硬碟leds燈號(hp g7/g6系統適用)說明

檢測頁面載入速度 利用google提供的檢測工具來測試網頁的載入速度

中國的網路審查(資訊長城) 介紹中國的網路審查(簡字网络审查、資訊長城或防火長城)

網路是平的?所以競爭來自四面八方! 在二十世紀末的時候,網際網路的出現改變了這個世界。但不表示你可以分一杯羹。

我有話要說


限制:留言最高字數1000字,超過部分會被截掉。 限制:未登入訪客,每則留言間隔需超過10分鐘,每日最多5則留言。

訪客留言

[無留言]

隨機好文

[jQuery] 利用load()來達成ajax的寫法 jQuery中利用load()來達成ajax的寫法,也有人稱他是假的ajax,作法就是..

為什麼要重造輪子? 什麼輪子?造什麼輪子?我為什麼要重造輪子?

看懂DSUB DVI HDMI USB等各式影音接頭 看懂DSUB DVI HDMI等各式影音接頭

UTF-8的網頁但IE8一片空白 UTF8編碼的網頁在Firefox 正常顯示、但IE8 就是空白,IE8編碼設定是「自動偵測」可是自動偵測到的是 big5...

最值得學的電腦技能 什麼是最值得學的電腦技能?程式設計?美工繪圖?系統網路?還是…? 都不是!個人覺得一個最值得學的電腦技能就