2009年2月10日 星期二

程式命名規則

古語有云,名不正則言不順。

如果用在程式撰寫上,

命名規則不一,亦或沒有規則可循,那將造成後來維護時無法找出原先寫法的用意。

在此列出命名的規則,首先需先說明兩種基本的方式:

Pascal Case:


每個單字的第一個字母大寫。EX: NormalDistribution


Camel Case:


除了第一個單字皆為小寫,其餘單字的第一個字母大寫。EX: normalDistribution



知道了上述的基本規則後,接著將依序說明命名空間、類別、介面、事件、函數以及變數名稱的規則:

  • 命名空間(Namespace)

  • JAVA-kind: java.awt.* 、 mact.ai.*  (camelCase)


    C#-kind: System.Data.*、 Mact.Ai.* (PascalCase)



  • 類別(Class)

  • Product、Consumer (PascalCase)



  • 介面(Interface)

  • IShape (PascalCase)



  • 事件(Event)

  • ActionListener (PascalCase)



  • 函數(Function、Method)

  • Java-Kind: getName()、addCar() (CamelCase)


    C#-Kind: GetName()、AddCar() (PascalCase)



  • 變數(Variable)

  • conn (CamelCase)


    但是這邊有一個例外的是,如果這個變數是常數變數,則所有的字母均需大寫。


    EX: JFrame.EXIT_ON_CLOSE




如果是寫Java 的人,可以參考官方出的文件手冊,Java撰寫原則

沒有留言:

張貼留言