Ruby 註解語法完整說明：單行、多行與最佳實務

註解是程式碼可讀性的關鍵。Ruby 提供單行與多行兩種註解語法，本文說明用法並分享對齊與風格建議。

單行註解

以 # 開頭，直到行尾：

#!/usr/bin/ruby -w
# 這是單行註解
puts "Hello, Ruby!"

輸出： Hello, Ruby!

多行註解

使用 =begin 和 =end 包裹，須獨佔行首：

#!/usr/bin/ruby -w
puts "Hello, Ruby!"

=begin
這是多行註解
可以跨越任意行數
但 =begin 和 =end 必須位於行首
=end

輸出： Hello, Ruby!

行尾註解對齊建議

將行尾註解與程式碼保持適當距離，多行時對齊縮進：

@counter      # 追蹤頁面點擊次數
@siteCounter  # 追蹤全站頁面點擊總數

最佳實務提醒

• 解釋「為什麼」而非「做什麼」
• 保持註解與程式碼同步更新
• 公開 API 應加上文件註解（RDoc/YARD 格式）