編輯器風格指南

前言

感謝你對 Godot 編輯器的貢獻與參與！

本頁說明 Godot 編輯器內所有內容應採用的語法和撰寫風格。遵循本指南有助於加速審核流程，讓你的貢獻更快被合併。

撰文風格

  • 訊息（錯誤、警告等）應以完整句子撰寫。 開頭首字需大寫，結尾加句點。

  • 盡量保持句子簡短。 這也有助於翻譯內容簡潔，降低介面出現問題的機率。

  • 使用縮寫型式。 例如使用 "isn't" 而非 "is not"。若需特別強調某字時則可例外。

  • 訊息內容請用雙引號（``""``）而非單引號（``''``）。雙引號可用於標示使用者輸入、檔案路徑及其他依語境需要的內容。

也參考

除了本頁規範外，也請一併遵循 文件撰寫方針 文件寫作指南。

按鈕與選單文字

按鈕與選單操作的文字請使用首字大寫樣式：

  • 正確： Open Editor Data Folder

  • 錯誤： Open editor data folder

若選單動作會開啟彈出式對話框，請於其後加上省略號（...）。

  • 正確： Editor Settings...

  • 錯誤： Editor Settings

屬性面板分節

通常不要為少於 3 個項目的內容建立新分節。太少項目的分節會讓屬性面板難以瀏覽，也失去分節（如可收合）的好處。

但此規則有一些合理例外，例如 StandardMaterial3D 中的材質功能。

這項建議同樣適用於 [專案設定] 與 [編輯器設定]。

屬性面板的效能提示

會明顯影響效能的列舉屬性應加上效能提示。提示內容應以*絕對*效能影響為準，而非僅相對於同一列舉其他選項。以下為 Godot 編輯器內的範例：

  • 螢幕空間反鋸齒： Disabled (Fastest), FXAA (Fast)

  • MSAA 品質： Disabled (Fastest), 2x (Fast), 4x (Average), 8x (Slow), 16x (Slower)

  • DirectionalLight 模式： Orthogonal (Fast), PSSM 2 Splits (Average), PSSM 4 Splits (Slow)

為維持一致性，請盡量只用以下詞彙（由快至慢排序）：

  • Fastest, Faster, Fast, Average, Slow, Slower, Slowest

不必全部連用。例如只用「Fast」與「Slow」即可。

若新增列舉屬性，其值應按最快至最慢排序。

工具提示

當按鈕或選單操作的功能不夠直觀時，請考慮加上工具提示。你也可以在提示中補充說明或提醒注意事項。

可透過在相應的 Control 節點呼叫 set_tooltip(TTR("Text here.")) 來設定工具提示。若提示內容特別長（約超過 80 字），請用 \n 分行顯示。

工具提示應遵循上面說明的撰寫風格，並以指示語氣（說明狀態），而非命令語氣（直接要求使用者）：

  • 正確： Computes global illumination for the selected GIProbe.

  • 錯誤： Compute global illumination for the selected GIProbe.