2016年11月27日 星期日

命名原則

第一、總是選擇慣例,在任何時候,慣例總是能讓大部分的人快速達成共識,而有時還能縮減程式碼,例如num可以代表number,i18n是internationalization的慣用縮寫
第二、清楚而明白的名稱,我原本把even or odd這個KATA的函數命名為eoo,結果朋友一問,eoo是什麼?我一時間也不知道他在說什麼,還得再回頭看一遍程式碼才知道原來是這個函數,於是我將它改成了完整的var evenorodd = function evenorodd(number) {...}
第三、精確地描述,例如用kill描述終結某個程序,用complete描述某個程序的完成,而兩者都可能被隨意地命名成end,那將是混亂的根源
第四、觀察出現位置,我寫ATM程式的時候,沒有太多思考就先命名出了提款、存款等函數。然而,這些程式碼由於封裝,其實是被ATM呼叫的,顯然改成加錢、扣錢才是合理的命名,因為使用它們的是ATM,而非ATM的使用者

沒有留言:

張貼留言