《Matlab編程風格》——命名習慣

轉自：http://blog.sina.com.cn/s/blog_50ee72f101009uo3.html

1 命名習慣

1.1 概要
*  命名多維變量或常量應該具有單位後綴；
*  命名中儘量避免縮寫；
*  考慮使得名字可以拼讀；
*  所有命名都應該以英語的形式給出。

1.2 變量
*  變量的名稱應該反應意義或用途。
*  應該是以小寫字母開頭的大小寫混合形式。
*  大範圍變量命名應該有意義，小範圍變量應該儘可能簡短。
如循環變量多用i j k m n等，雙精度數多用x y z
*  集合變量一般多用Array標記，儘量不要使用單詞的複數形式。
如pointArray
*  只代表單個個體的變量可以用No或i標記
如tableNo, iTable
*  循環變量以i j k等開頭
*  單個變量用n開頭，向量用a開頭，矩陣用m開頭。
*  儘量避免否定式布爾變量命名。
如isNotFound不好，用~isFound。
*  縮寫形式，即使是大寫縮寫，也要大小寫字母混合。
如isUSASpecific不好，用isUsaSpecific

 

1.3 常數
*  應該使用大寫字面，用下劃線分割單詞。
如MAX_ITERATIONS
*  可以使用某些通用類型名爲前綴，指明它們屬於哪一類。
如COLOR_RED，COLOR_BLUE

 

1.4 結構體
*  應該以一個大寫字母開頭。
如Point
*  其字段命名不應該包含結構體名
如Segment.SegementLength是不好的，直接用Segment.length

 

1.5 

函數
*  函數名應該表明函數用途。
*  函數名應該與它的m文件同名。
*  函數名應該採用小寫字母，可以用下劃線隔開。
如getname，get_name
*  儘量不要使用短命名，使用完整單詞增強可讀性，但廣泛使用的縮寫或首字母縮寫例外。
如compwid不好，使用computewidth。max，gcd都可以。
*  單輸出變量函數可根據輸出參數命名。
如mean
*  沒有輸出變量或返回值爲句柄的函數根據其功能命名。
如plot
*  前綴set/get應該作爲訪問對象或者屬性的保留前綴。
如getobj，setappdata。
*  前綴compute用在某些量的計算上，暗指比較好耗時的操作。
如computespread
*  前綴find用在具有查詢功能的函數上，可以增強可讀性，是get的一個好的替代品。
如findoldestrecord，
*  前綴initialize可以用在對象或概念建立的地方。
如initializeproblemstate
*  前綴is應該用在布爾函數的命名的地方。
如iscomplete
*  補足型前綴應該用在補足型操作的地方。
如get/set，add/remove，create/destroy，start/stop，insert/delete，increment /decrement，old/new，begin/end，first/last，up/down，min/max，next /previous，open/close，show/hide，suspend/resume。
*  避免無意識的覆蓋。保證函數名的唯一性。可以用which –all或exist檢查函數是否存在。