Up to date
This page is up to date for Godot 4.2
.
If you still find outdated information, please open an issue.
編輯器風格指南¶
前言¶
感謝你有興趣參與貢獻 Godot 編輯器!
本頁介紹了 Godot 編輯器內應使用的語法與撰文風格。遵守本風格指南有助於協助你的貢獻更快被合併,因為所需的審閱步驟較少。
撰文風格¶
以完整句子來撰寫訊息 (錯誤、警告…等)。 這些訊息應以大寫字母開始,並以句點結束。
儘量保持句子簡短。 這樣一來通常也能使翻譯更短,進而減少 UI Bug。
使用縮寫。 如,應使用「isn't」而不是「is not」。但當需要強調縮寫的單詞時即可忽略此規則。
在訊息中使用雙引號 (
""
) 而不是單引號 (''
)。雙引號應用於包括使用者輸入、檔案路徑以及其他所有依據文脈決定的東西。
也參考
除了上述提到的方針外,也請儘量遵守 說明文件撰寫方針 。
屬性面板分段¶
一般來說,請不要為了少於 3 個專案的內容建立新的分段。內容很少的分段會讓使用者難以瀏覽屬性面板,且會喪失一些如摺疊等使用段落的好處。
但此規則有一些合理的例外,如 class_SpatialMaterial 中的材料功能。
本建議也適用於 [專案設定] 與 [編輯器設定]。
屬性目標中的效能提示¶
會明顯影響到效能的列舉型別屬性應該要有相關的效能提示。這些效能提示應該要以 絕對 效能影響作為參考,而不是使用與列舉型別中其他值相對的效能。下列為從 Godot 編輯器中找出的範例:
Screen-space antialiasing: Disabled (Fastest), FXAA (Fast)
MSAA quality: Disabled (Fastest), 2x (Fast), 4x (Average), 8x (Slow), 16x (Slower)
DirectionalLight mode: Orthogonal (Fast), PSSM 2 Splits (Average), PSSM 4 Splits (Slow)
為了保持一貫性,請儘量使用下列這些單字 (從最快 Fastest 至最慢 Slowest):
Fastest, Faster, Fast, Average, Slow, Slower, Slowest
不需要使用連續的單詞。舉例來說,可以只用上表中的「Fast」與「Slow」兩個就好。
若要新增新的列舉型別,則其數值應以最快 (Fastest) 的選項排列至最慢 (Slowest) 的選項。
工具提示¶
當某個按鈕或選單操作所執行的操作並不明顯時,請考慮新增工具提示。也可以在工具提示內提供額外的本文或提示操作的結果。
可以通過在所需之基於 Control 的節點上呼叫 set_tooltip(TTR("Text here"))
來為其加上工具提示。若工具提示特別長 (多於 80 個字元),請通過加上 \n
來將其分為數行。
工具提示應遵守前述之撰文風格。另外,請使用指示性的語調而非命令性:
Good: Computes global illumination for the selected GIProbe.
Bad: Compute global illumination for the selected GIProbe.