在 Ruby 程式設計中,註釋是讓程式碼更易讀、更易維護的基礎工具。無論你是初學者還是資深開發者,掌握正確的註釋寫法都能顯著提升團隊協作效率。本文將詳細介紹 Ruby 中單行註釋、多行註釋的語法與使用技巧,並提供實際程式碼範例供參考。
Ruby 使用井號(#)作為單行註釋的起始符號。從 # 到該行結尾的所有內容都會被解釋器忽略,不會被執行。
#!/usr/bin/ruby -w
# This is a single line comment.
puts "Hello, Ruby!"
執行結果:
Hello, Ruby!
註釋也可以放在程式碼同一行的末尾,用於說明該行的具體功能:
@counter # keeps track times page has been hit
@siteCounter # keeps track of times all pages have been hit
建議將行尾註釋對齊,並與程式碼保持適當距離,這樣能讓程式碼結構更清晰易讀。
當需要註釋大段程式碼或撰寫詳細說明時,可以使用 =begin 和 =end 配對標記。這對標記必須分別獨佔一行,且位於行首。
#!/usr/bin/ruby -w
puts "Hello, Ruby!"
=begin
This is a multiline comment
and can span as many lines as you like.
But =begin and =end should come in the first line only.
=end
執行結果:
Hello, Ruby!
掌握這些註釋技巧,能讓你的 Ruby 程式碼更專業、更易於團隊協作與長期維護。