iT邦幫忙

2019 iT 邦幫忙鐵人賽

DAY 6
0
自我挑戰組

易讀程式之美學系列 第 6

富含資訊的名稱--名稱該有多長

  • 分享至 

  • xImage
  •  

最好依變數的使用方式有所不同,但以下原則有助於讀者決定。

較小的範圍適合用較短的名稱

if (debug){
map<string,int> m;
LookUpNameNumbers(&m);
Print(m);
}

即使m是個不含任何資訊名稱也沒關係,一眼就可以理解程式碼所需的所有資訊。
然而,如果m是類別成員或全域變數,那以下程式碼:

LookUpNameNumbers(&m);
Print(m);

的可讀性就差多了,無法從程式碼清楚知道m的類別與目的。
如果識別字有較大的範圍,名稱就應該含有讀者理解所需的資訊。

略縮寫與縮寫

程式設計師有時候會利用略縮寫與縮寫維持名稱的短小,
ex:將類別取名為BEManager,而非BackEndManager

這樣的縮寫大多不是好事,程式看起來太過神祕也會新人感到害怕。一段時間後,甚至連原作者都會覺得難懂。

因此,可以依據經驗判斷「新成員能不能理解名稱所代表的意義?」如果可以,大概就沒什麼問題。

排除不必要的辭彙

有時候消除名稱部份辭彙不會影響包含的資訊量。

ConvertToString()->ToString()

DoServerLoop()->ServerLoop()

Reference

  • <<易讀程式之美學-提升程式碼可讀性的簡單法則 >>(The Art of Readable Code)

上一篇
富含資訊的名稱--在名稱中加入額外資訊
下一篇
富含資訊的名稱--利用名稱格式加入更多意義
系列文
易讀程式之美學30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言