7種過時的代碼風格
如果您已經進行了十多年的編碼,那么您可能會擁有一些堅定的首選樣式,您會堅定地相信這些樣式,并堅持自己的觀點來捍衛它們直到最后。
下面是我曾經堅定支持過的一些人,但現在我認為我必須放手。
1. 使用m或this表示成員變量
規則:要區分成員變量和局部變量,請使用以下任一方法:
- 使用匈牙利表示法,即mMemberVariable與localVariable。 其中m代表成員變量。
- 這個的使用 this.member變量與局部變量。
過時的原因:
原因是當我們閱讀代碼時,可以很容易地知道它們是成員變量還是局部變量,而無需查看它們的聲明。
- class MyClass {
- var mMember = "member"
- fun doSomething() {
- val local = "local"
- println(this.mMember)
- println(local) }}
現在:
如果是現代IDE,則不再需要這種基于文本的區分。 參見下面的相同代碼,它將自動為它們涂上不同的顏色。
> Different coloring of variables
2. 明確聲明Public,Protected或Private
規則:一個類中的所有變量和函數都必須明確聲明為public,private或protected。 不要采用默認狀態。
- 需要明確說明類型,例如 字符串或整數
- 需要明確說明它是私有的還是公共的
- public class MyClass {
- public val publicVariable: String = "100"
- private fun privateFunction() {}
- public fun publicFunction() {}
- }
過時的原因:
這是為了避免有人錯誤地訪問這些函數或變量,即,如果未聲明函數,則用戶可能不知道默認狀態(如果是公共狀態或私有狀態)。
現在:
使用現代IDE,我們無需明確聲明默認值,例如 對于公開的Kotlin。 用戶不會無意中誤認為默認狀態,因為自動完成只會顯示公共方法。 因此,不太可能有人會混淆默認狀態。
> The private Function won't appear on auto-complete
如果有任何錯誤用法(例如訪問私有功能),它不會僅在編譯時出現錯誤。 立即出現錯誤并顯示一條清晰消息。
3. 總是顯式聲明變量類型
規則:所有變量均應使用其類型聲明,即使從已為其賦值的值很明顯即可,例如 需要明確說明類型,例如 字符串或整數
- public class MyClass {
- public val publicVariable: String = "100"
- private fun privateFunction() {}
- public fun publicFunction() {}
- }
過時的原因:
這是為了避免有人錯誤地訪問這些功能或變量,例如 變量分配給錯誤的類型,并導致編譯錯誤。
現在:
如果使用現代編程語言,則在可推斷且明確的情況下,無需顯式聲明變量的類型。 這稱為類型推斷。 如今,它可以多種現代語言提供。
如果有任何錯誤的分配等,它不會僅在編譯時出錯。 立即出現錯誤并顯示一條清晰消息。
> 10 + MyClass().publicVairable will error out immediately as Int and String can't be added together
4. 成員變量應始終為私有
規則:所有應為私有的并通過getter和setter訪問的成員變量適用于需要在外部設置或獲取的成員變量。
- public class MyClass{
- private var member = "member";
- public fun getMember(): String {
- return member;
- } public fun setMember(value: String) {
- member = value; }}
過時的原因:
如果我們將其公開以進行設置和獲取,則在設置或獲取它們時需要執行一些操作時,我們需要更改所有訪問它的代碼。
因此,如果我們限制使用getter和setter,則可以控制它。
- class MyClass{
- private var member = "member";
- fun getMember(): String {
- println("Setting member") return member;
- } fun setMember(value: String) {
- println("Setting member with $value") member = value;
- }}
現在:
在現代語言(例如Kotlin)中,我們可以在需要時輕松地將變量getter或setter插入變量,而無需明確地具有兩個僅用于設置和獲取的函數。
因此,我們可以按以下方式進行編碼,而無需在類中添加附加的setter和getter函數。
- class MyClass { var member = "member"}
當我們需要對setter或getter進行操作時,我們可以輕松地添加它們,而無需更改訪問成員的代碼。
- class MyClass {
- var member = "member"
- get(): String {
- println("Setting member")
- return field
- } set(value: String) {
- println("Setting member with $value")
- field = value
- }}
5. 開始和結束大括號應對齊
規則:所有大括號應在同一列對齊,以便我們可以輕松找到它們,例如:
- class MyClass
- { private var member: String = "member"
- fun doSomething(state: Boolean)
- { val local = "local"
- println(member) println(local) }}
過時的原因:
原因是通過垂直查看,我們可以輕松找到它們的對,從而知道函數的作用范圍在哪里。
現在:
使用新的IDE,只要代碼看起來很整潔,我們就不再需要在同一列上對齊開始和結束大括號。
- class MyClass {
- private var member: String = "member"
- fun doSomething(state: Boolean) {
- val local = "local"
- println(member) println(local) }}
這是因為我們可以輕松折疊或展開它們,如下所示。
> Easily expand or collapse code scope
要了解有關大括號的更多信息,請查看以下內容。
6. 對所有縮進使用制表符
規則:對所有縮進使用制表符,而不要使用空格
過時的原因:
這減少了所需的鍵入次數。 例如 下面顯示了使用空格時,必須多次鍵入
> The old text editor, one need to type every space
現在:
使用IDE,它將為我們自動縮進適當數量的空格。 擁有空格還將確保所有代碼在整個用戶環境中看起來都一致。
> The modern IDE, till perform auto-indentation of spaces
7. 使用分號結束代碼聲明
規則:在結束代碼語句時,必須使用分號。
過時的原因:
這是必需的,因為從前的編程語言(包括C和C ++,Java等)使解析器識別它已經結束。 部分原因是因為我們有80列,因此當需要為一條語句編寫更多代碼時,我們可以為一條語句編寫多行代碼。
現在:
使用新的現代語言(例如Kotlin),不再需要編寫長語句(例如,我們可以將變量命名為較短,縮進的縮進形式)。
即使我們需要編寫更長的語句,我們也不再受限于8列(盡管這不是一個好習慣)。 此外,這幾天我們的顯示器更長longer
> Photo by Fotis Fotopoulos on Unsplash
因此,如果一種語言不允許使用分號,那就去吧!
要進一步詳細說明項目4–7,您可以閱讀以下內容。
通過改變對上述7種編碼樣式的信念,我對代碼進行了如下更改:
世界在不斷變化。 過去的要求可能不再適用。 借助技術和工具,我們應該始終重新評估我們曾經擁有的規則,并繼續前進。
感覺這么年輕。 看看編碼行業是如何變化的!