bad_code.md

!SLIDE bullets incremental left

為什麼 Code 這麼容易腐敗？

!SLIDE

其實大多數 Rails Developer 不會寫 Rails

!SLIDE bullets left

常見的 Rails Code

• 晦澀：難以閱讀，無法了解意圖
• 不需要的重複：相同概念的程式碼被複製貼上重複使用
• 黏滯：彈性不夠，把事情做對比做錯還難
• 固定： 難以分解，讓程式再重用
• 脆弱： 一旦修改，別的無關地方也炸到
• 僵硬 : 難以修改，每改一處牽一髮動全身

!SLIDE center

Spaghetti code

!SLIDE bullets left

Spaghetti code 的成因

• Don't know how to code
• IT JUST WORKS!
• PHP, .NET, JAVA coding tyle
• unfamiliar with Rails way

!SLIDE bullets xleft

Common Antipatterns

• 不好的程式寫作習慣
• 不適當的 Coding Style
• 隨意亂扔程式碼
• 到處複製貼上程式碼
• 濫用 Framework / ORM
• 重複發明輪子

!SLIDE

使用大量的縮寫

不好的寫作習慣

!SLIDE code left

無法理解

  def t_tags
    t_list.join(" ")
  end

容易理解

  def tokenized_tags
    tag_list.join(" ")
  end

!SLIDE

能夠不縮寫就不縮寫

真的太長的 method name ( 3個詞以上)，使用 module 或 namespace

!SLIDE code left

無法了解意義的變數

錯誤

      case game_type
  when "1"
    # do_something_x
  when "2"
    # do_something_y
  when "3"
    # do_something_z
  else
    # redirect_to root_path
  end

  

!SLIDE code left

正確

      case game_type
      when "rpg"
        # do_somehting_x
      when "strategy"
        # do_something_y
      when "fps"
        # do_something_y
      else
        # redirect_to root_path
      end
  

!SLIDE

濫用 elsif

不好的寫作習慣

!SLIDE code

邏輯混亂

    if color=="red"
      print "red"
    elsif color="green"
      print "green"
    elsif orignal_color=="yellow"
      print "yellow"
    else
      print "orange"  
    end

!SLIDE code

容易理解

  if original_color == "yellow"
    print "yellow"
    return
  end
case color
when "red"
print "red"
when "green"
print "green"
else
print "orange"
end

!SLIDE

語意不明

不好的寫作習慣

!SLIDE code

動詞 / 名詞 / 形容詞 傻傻搞不清楚

錯誤

  post.is_hide
  

正確

  post.is_hidden
  

!SLIDE code

是不是 spam ? => 疑問，回傳 true / false

    post.is_spam?
  

標記為 spam! => bang，改變狀態

    post.is_spam!
  

!SLIDE

濫用自創名詞

不好的寫作習慣

!SLIDE code

攻 / 受 ( 錯誤示範 )

  attacker / defender 
  

傳送者 / 接收者 ( 正確示範 )

  sender / reciever
  

!SLIDE

類似的 method，變數與寫法不一致

不好的寫作習慣

!SLIDE center

一下使用 block, 一下使用 lambda

類似的 method，寫法不一致

!SLIDE

不適當的 Coding Style

!SLIDE center

不一致的縮排

!SLIDE center

method 使用 CamelCase

!SLIDE center

more on...

The Book of Weird Ruby

擁有各式各樣奇怪的 Ruby 範例

!SLIDE bullets incremental left

正確的 Ruby Coding Style

• Use 2 space indent, no tabs.
• Use snake_case for methods.
• Use CamelCase for classes and modules.
• Use SCREAMIN_SNAKE_CASE for other constants.

!SLIDE bullets incremental left

正確的 Ruby Coding Style

• 大範圍的程式碼使用 do end。1-2 行使用 lambda {}
• 定義 method 要加括號 ()。除非是宣告或 command
  • 加括號：hello(name) # 一般 method
  • 可不加括號： attr_accessible :nickname # 宣告或 command

!SLIDE center

more on...

Eloquent Ruby

學習寫正確的 Ruby code

!SLIDE

如果你的 code 不直觀的話，你不是在寫 Ruby code

!SLIDE

道德底線： Readability ( 易讀，容易了解 )