UE4基礎:命名約定(關於U、A、S、b等前綴)

譯自《Coding Standard》by Unreal官方

命名約定

  • 每個單詞的首字母(注入類型名或變量名)大寫,並且中間沒有下劃線。例如:HealthUPrimitiveComponent都是正確的,不要寫成lastMouseCoordinates或者delta_coordinates

  • 類型名前面加上額外的大寫字母前綴以區別於變量名。例如,FSkin是個類型名, Skin則是FSkin的一個實例。

    • 模板類的前綴是T

    • UObject類的派生類前綴是U

    • AActor類的派生類前綴是A

    • SWidget類的派生類前綴是S

    • 抽象接口類前綴是I

    • 枚舉類型前綴是E

    • 布爾類型變量的變量名必須加上前綴b(例如:bPendingDestruction或者bHasFadedIn)。

    • 絕大多數其它的類,類型名前會有前綴F,一些子系統可能會使用其它字母。

    • 類型別名(typedef)也應當使用恰當的前綴:如果是一個結構體(struct)則應使用前綴F。如果是一個UObject的派生類則應使用前綴U,以此類推。

      • 一個模板實例已經不再是一個模板類,因此其別名前綴應如:
    typedef TArray<FMytype> FArrayOfMyTypes;
    
    • 在C#代碼中將忽略前綴
    • 大多數情況下,UnrealHeaderTool會要求正確的前綴,因此一定遵守規則。
  • 類型名和變量名都應該是名詞。

  • 方法名應該是描述該方法或者其返回值意義的動詞。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章