簡易的命名原則

實習以後時再遇到太多的"實務經驗"的洗禮了

以前繳作業大概就是能跑出結果,不要出大問題就ok
雖然也都教過一些原則跟"良好的程式"應該具備的東西,不會被釘的時候常常就....可以看就好啦~

然而到了實習發現很多原則不遵守都不行,甚至要求的還比較嚴格
因為在專案變大已經不是自行玩玩的小程式了,人員、規格、嚴謹程度都大幅提升
也開始懂得「為什麼測試步驟常常被跳過」、「程式設計師跟需求端的溝通困難」之類的心情了XD


不過被釘了三個禮拜後,確實也學到滿多經驗跟擴展一些視野
今天記錄一下學到的一些命名原則

  1. 命名的要有意義:
    最基本的要求,在境界上「讓大家不用看註解就能看懂」是最佳情況,因為註解可能寫的跟程式不同,但所有根本應該都還是程式。
  2. 盡量不要縮寫,把完整單字寫出,除非有特定領域大家都可接受的縮寫:
    確保其他人一看就看得懂的意思
  3. 有「Camel Case」和「Pascal Case」兩種主要的命名方法
    Camel Case:第一個字開頭小寫,後續單字開始大寫。如:firstName
    Pascal Case:第一個字開頭大寫,後續單字也都大寫。如:FirstName
  4. 避免使用符號、空白跟底線:
    利用第3點的方式來命名
  5. 命名沒有絕對,可以參考團隊的開發手冊,整個團隊可以接受有共識即可。


另外不確定是OO都這樣還是只有Java(相較其他OO語言,只對Java比較熟悉一點...)
  1. 類別名稱常用名詞,以大寫開頭(Pascal Case);
    class ImageSprite;

    屬性名稱、參數名稱常用名詞,小寫開頭(Camel Case);
    float myWidth;

    方法名稱常用動詞開頭,小寫開頭(Camel Case);
    runFast();
    createTable();

    介面名稱常用形容詞,以大寫開頭(Pascal Case)。
    interface Storing;
    
    
  2. 介面的命名通常會加上I:例如Customer類別要實作ICustomer介面


天吶~記不完,程式設計這種東西呢...最好的方法就是多寫,養成習慣!!
羨慕那些良好的Coding Style,可以寫出漂亮、乾淨的程式><

菜鳥如我呢,也只能沒日沒夜的co來追上其他人了,哈哈

留言

這個網誌中的熱門文章

API、Method和Library是什麼東西和關係?

《人月神話》簡易心得

Asp.net的網頁生命週期