编辑器风格指南

简介

感谢您有兴趣为Godot编辑器投稿！

本页介绍了Godot编辑器中使用的语法和写作风格.遵循这一风格指南将有助于您的贡献更快地被合并,因为所需的审核步骤更少.

写作风格

  • 将信息(错误、警告……)写成完整的句子 ,应以大写字母开头,以句号结束.

  • 尽量保持句子简短. 这使得他们的翻译也可能很短,这对于避免UI错误有好处.

  • 使用缩略语. 例如,用 “isn’t”代替 “is not”.当你特别想强调缩略词之一,则例外.

  • Use double quotes in messages ("") instead of single quotes (''). Double quotes should be used to quote user input, file paths and possibly other things depending on the context.

参见

除了上述准则外,尽量遵循 文档编写指南 .

按钮和菜单文本

将按钮和菜单操作中的文本大写:

  • Good: 打开编辑器数据文件夹

  • Bad: 打开编辑器数据文件夹

如果菜单操作打开了模式对话框,用省略号( ... )作为后缀.

  • Good: 编辑器设置…

  • Bad: 编辑器设置

检查器插件

一般来说,不要创建包含少于3个项目的部分.包含项目少的章节会使浏览检查器变得困难,同时丢失了使用章节的好处,如折叠.

有一些有效的例外情况,例如 SpatialMaterial 中的材质特征.

这个建议也适用于项目设置和编辑器设置.

检查器性能提示

显著影响性能的枚举属性应该具有相关的提示,该提示应该是指 绝对 的性能影响,而不是相对于枚举中提供的其他选项.下面是Godot编辑器中的一些例子:

  • **屏幕空间抗锯齿:禁用(最快),快速近似抗锯齿(快速)

  • MSAA质量: 禁用(最快)、2倍(快)、4倍(一般)、8倍(慢)、16倍(慢)

  • 方向光模式: 正交(快),PSSM 2分割(平均),PSSM 4分割(慢)

为了保持一致,尽量按照下面的术语(从最快到最慢):

  • Fastest[最快], Faster[较快], Fast[快], Average[平均], Slow[慢], Slower[较慢], Slowest[慢]

它们的用法不一定要连续.例如,你可以只使用上面列表中的 “快”和 “慢”.

如果你要添加一个新的枚举,它的值应该从最快的选项到最慢的选项排序.

工具提示

每当按钮或菜单操作所执行的操作不明显时,可以考虑添加工具提示.你也可以在工具提示中提供额外的上下文或强调注意事项.

你可以通过调用 set_tooltip(TTR("Text here.")) 来实现。如果tooltip特别长(超过80个字符)，可以通过使用 \n 添加换行符将其包裹在几行上。

工具提示应遵循上述的书写风格.除此之外,要使用指示性而不是命令性:

  • 好: 计算所选的GLProbe全局光照.

  • 差: 计算所选的GLProbe全局光照.