From 2809e37a97e58c4920b4631052f9903af7a5a74e Mon Sep 17 00:00:00 2001 From: ruki Date: Sat, 22 Jun 2019 10:49:32 +0800 Subject: add manual --- manual/specification.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 manual/specification.md (limited to 'manual/specification.md') diff --git a/manual/specification.md b/manual/specification.md new file mode 100644 index 00000000..f3e89cac --- /dev/null +++ b/manual/specification.md @@ -0,0 +1,18 @@ +## Naming conventions + +The interface is named according to some of the predefined specifications, which is more convenient to understand and easy to use. + +It's according to the following rules: + +| Interfaces | Description | +| --------------------- | ---------------------------------------------------------------- | +| `is_`/`has_` + xxx | Condition interfaces | +| `set_` + xxx | Set and override the previous settings | +| `add_` + xxx | Set and append settings | +| `…s` + xxx *(plural)* | Support multi-parameters, .e.g：`add_files("*.c", "test.cpp")` | +| `on_` + xxx | Set and override builtin script | +| `before_` + xxx | Set and run this script before running builtin-script | +| `after_` + xxx | Set and run this script after running builtin-script | +| `scope("name")` | Define a description scope, .e.g `target("xxx")`, `option("xxx")`| +| scope/settings | Indentation with spaces | + -- cgit v1.2.3