文件名
- 规范:使用小写字母和下划线(
_
),避免使用大写字母和特殊字符,文件名应清晰描述其功能或内容。 - 示例:
main_view.qml
、user_profile.qml
、settings_page.qml
ID名
- 规范:ID名用于唯一标识一个元素,必须以小写字母开头,可以使用下划线(
_
)分隔单词。 - 示例:
id: mainButton
、id: userListView
、id: settingsPanel
属性名
- 规范:属性名应以小写字母开头,使用驼峰命名法(camelCase)或下划线分隔单词,私有属性可以以两条下划线开头(
__
)。 - 示例:
text: "Hello World"
、fontSize: 14
、__privateProperty: 42
信号名
- 规范:信号名应以小写字母开头,使用驼峰命名法或下划线分隔单词,通常以“ed”结尾表示事件。
- 示例:
signal clicked()
、signal valueChanged(int newValue)
函数名
- 规范:函数名应以小写字母开头,使用驼峰命名法或下划线分隔单词。
- 示例:
function calculateSum(a, b) { ... }
、function updateUI() { ... }
模块名和别名
- 规范:导入的模块或JS文件别名应以小写字母开头,使用下划线分隔单词。
- 示例:
import MyModule 1.0 as MyModule
、import "js/utils.js" as Utils
类型名
- 规范:自定义类型名应以大写字母开头,使用驼峰命名法。
- 示例:
import CustomComponent 1.0 as CustomComponent
避免命名冲突
- 如果需要避免与QML内置属性或类型冲突,可以在名称前添加前缀或下划线,使用
U_
表示UI相关,C_
表示核心功能,P_
表示原型等。 - 示例:
U_MainView
、C_CoreComponent
、P_Prototype
可翻译字符串
- 对于需要本地化的字符串,可以使用
qsTr()
函数包裹,确保字符串可以被翻译工具识别。 - 示例:
text: qsTr("Hello World")
锚点(Anchor)命名
- 锚点用于定义元素的位置,通常使用
anchors.*
属性,如anchors.centerIn: parent
。
QML中的命名应遵循清晰、简洁、一致的原则,避免使用大写字母和特殊字符,尽量使用小写字母和下划线或驼峰命名法,通过合理的命名,可以提高代码的可读性和可维护性。
标签: #QML 命名规范
评论列表