Ruby程式碼格式化美化工具

把 Ruby 原始碼整理成較易閱讀的文字

這項工具接收貼上的 Ruby 程式碼，提供「格式化」與「壓縮」兩種文字整理方式。格式化會整理行首縮排、行尾空白、部分行內空格與逗號後空格；可選 2、4、8 個空格或 Tab，也能選擇移除註解。結果會隨輸入或選項變更而更新，可複製或下載成 formatted.rb。這適合快速整理片段、準備閱讀或比對，不會執行程式。

Ruby 程式的結構不只由行首關鍵字決定，也可能包含字串、區塊、修飾式條件、內嵌文件等不同語法。Ruby 官方語法文件列出這些語言結構；因此，排版看起來整齊並不等於通過語法解析或檢查。

格式化與壓縮的差異

「格式化」依常見的 def、class、if、do 等結構調整縮排，保留註解的設定預設為關閉移除；「壓縮」則清掉空白行、合併部分連續空格並移除註解，結果仍可能保留多行，不是保證輸出單行的編譯產物。畫面顯示的字元數與行數可協助比較輸入和輸出；壓縮時的長度變化只表示文字長度差異，不能解讀成程式變快或檔案必然等價。

先用短片段確認整理方式

1. 貼上 Ruby 原始碼，或載入頁面範例；輸入與結果區會顯示字元數和行數。

2. 選「格式化」後，依專案慣例設定縮排寬度與空格或 Tab。若要刪除註解，再開啟移除註解選項；若只是想壓縮文字，改選「壓縮」，此模式會自動移除註解。

3. 檢視輸出中的字串、註解和區塊層級，再複製或下載 formatted.rb。正式採用前，將差異與原始檔逐段比對。

例如，輸入未縮排的 def greet(name)、puts "Hi, #{name}" 和 end，格式化模式會把方法內的輸出行縮排。這個例子只示範文字排版；複雜程式請以實際檔案檢查結果。

使用選項與輸出常見疑問

重要程式碼請保留原檔並驗證差異

這項整理依逐行文字及常見關鍵字、括號模式調整空白和縮排，並非完整 Ruby 語法解析器。遇到 HERE 文本、特殊字串、修飾式條件、巢狀區塊或不完整片段時，輸出可能不符合預期；不能保證格式化或壓縮後的程式行為完全不變。工具不會替你找出語法錯誤或執行測試。

移除註解可能影響理解；尤其 Ruby 檔案開頭的 Magic Comments 可指定編碼或字串字面值處理方式，官方文件說明它們會影響檔案解讀。壓縮模式會自動刪除註解，使用前務必確認來源檔沒有需要保留的指示。重要程式請保留原件、檢查版本差異，並在目標 Ruby 版本和專案測試中驗證後再採用。