This is a mirror page, please see the original page:
https://xmake.io/#/zh-cn/manual/specification命名规范
接口的命名,是有按照预定义的一些规范来命名的,这样更加方便理解和易于使用,目前命名按照如下一些规则:
接口规则 | 描述 |
---|---|
is_ , has_ 前缀的接口 |
表示为条件判断 |
set_ 前缀的接口 |
表示为覆盖设置 |
add_ 前缀的接口 |
表示为追加设置 |
s 后缀的接口 |
表示支持多值传入,例如:add_files("*.c", "test.cpp") |
on_ 前缀的接口 |
表示为覆盖内置脚本 |
before_ 前缀的接口 |
表示为在内置脚本运行前,执行此脚本 |
after_ 前缀的接口 |
表示为在内置脚本运行后,执行此脚本 |
scope("name") 的接口 |
表示为定义一个描述域,例如:target("xxx") , option("xxx") |
描述域/描述设置 | 建议缩进表示 |