簡易的命名原則

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

以前繳作業大概就是能跑出結果，不要出大問題就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是什麼東西和關係？

圖片
這三者我一直搞不清楚，有時候API跟Method好像差不多，有時候覺得API概念不就跟Library一樣嗎？ 後來發現這三者差別，需要視它們是對於一個"應用程式"而言是在什麼位置。是應用程式本身，還是不相關的應用程式，還是想要與應用程式互動的外部應用程式。 先來個例子： 今天有一個甲應用程式提供了API ReturnNumber(int a) 而甲應用程式裡面的處理是 int ReturnNumber(int a){ return round(random(a)); }; 接著我們一一解釋它們各是甚麼。 round()、random()：是由內建library提供的兩個method ReturnNumber()：是一個自己寫的Method，但因為我們提供它給外部使用，所以也是個API。 假設乙應用程式用了ReturnNumber()這個API，則只能傳進一個參數a，實際上他不知道這個API裡面寫了什麼，只能透過甲提供的文件說明來知道用途。 這個例子可以看到三者的實例，接著再來進一步說明。 ----------------------------------------------------------------------------------------------- API、Method和Library的關係 【Library】 函式庫，指將一群已經寫好的Method(Function)包成一個Library，當我們import這個Library後就能使用其包含的Method。(此處只是個程式語言的稱法不同，Method指Java、Function指C) 【API( A pplication P rogramming I nterface)】 應用程式介面，指提供給 外部程式 存取或是已經寫好的功能，事實上可以把它當作一群Method的集合，外部程式只能用這些Method。 【Method】 在Java稱為Method，類似C的Function，但不完全相同，這又是另一段故事了。 (在物件導向中的Method是綁定Class，所以要用Method一定要先實體化一個Object。ex. student.gohom
閱讀完整內容

《人月神話》簡易心得

這本真的是很有收穫的書籍，對於在軟體產業工作(尤其是by專案)，看完有著很大的共鳴跟反思。（還沒進產業時曾看過一遍，實際工作後再看一遍又有更深的體會。） 重點是這是三十年前寫的書，而隨著技術與工具的進步，軟體專案發展到現在仍然有書中所說的種種困境與難題，看完會覺得作者真的對軟體專案看得很透徹。 簡短心得就把每一章濃縮成我覺得最重要的「一兩句話」，避免太發散。 但書裡面的內容絕對不只、也無法用一句話精準的概括，只是這樣比較方便記憶而已。
閱讀完整內容

新增欄位，該用alter還是create and drop

最近遇到一個需求是需要DB新增欄位 思考後發現有兩種做法 1. Alter Table ... ADD Column 2. create&drop重新建一個新的table：複製舊的資料表格式，並加入新的欄位，再將舊資料表的資料SELECT INTO至新的資料表，最後重新命名為原本的資料表名稱。 作法1的速度非常快，但是在SQL Server中，ALTER ADD的欄位是無法指定排序的，因此新加入的欄位一定會排在最後，我是認為在觀看上有點不便與醜陋。 由於兩種做法都可行，因此問了資深前輩，trade off的考量點應該要有哪些，得到一些原本沒想到的觀點，順便整理記錄一下。 1. 系統是否已經上線 已經上線的系統，如果採用方法2，風險會比較高，因為轉換資料的過程中會lock住資料，萬一資料量大的時候，需要的時間就很長，萬一有其他使用者需要使用，可能會導致連線逾時。 且轉換的過程中，萬一中途有些資料失敗了，會不知道斷在哪裡，造成資料的不一致；如果採用transcation，則會lock更多資料。 2. 造成的影響最小化 在擴充功能的時候，優先考量的一定是有沒有side effect，如果造成side effect會讓系統品質變得更難維護。而方法1跟2，基本上都不太會影響原本系統邏輯（如果當初寫在系統中的使用語法都有明確指定欄位，沒有使用select * from table的寫法），因此在變動所產生的影響最小化考量，1跟2是都可以採用的。 3. 資源耗用量 MS SQL server有提供的圖形化介面操作，可以移動欄位的順序，看起來非常的方便。但如果我們再進階一點去使用「產生指令碼」的功能，會發現 系統做的事情底層還是select into綁上交易的作法 ，只是沒讓我們看到而已，因此資料量愈大（上千萬筆），採用方法2所耗用的資源就愈多。 最終還是選擇的方法1的做法，因為影響最小，且系統已經上線使用。
閱讀完整內容