Mirrors_UI_SDK/lvgl
1
0
Fork 0
mirror of https://github.com/lvgl/lvgl.git synced 2026-06-02 01:18:04 +08:00
Code Issues Actions 36 Packages Projects Releases Wiki Activity

Update CODING_STYLE.md

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2020-05-25 06:35:00 +02:00
committed by GitHub
parent 2078e4a01a
commit dfb7c6731c
1 changed files with 8 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CODING_STYLE.md
+8 -13
View File
@@ -1,6 +1,7 @@
# Coding style
## File format ## File format
Use [lv_misc/lv_templ.c](https://github.com/littlevgl/lvgl/blob/master/src/lv_misc/lv_templ.c) and [lv_misc/lv_templ.h](https://github.com/littlevgl/lvgl/blob/master/src/lv_misc/lv_templ.h) Use [lv_misc/lv_templ.c](https://github.com/lvgl/lvgl/blob/master/src/lv_misc/lv_templ.c) and [lv_misc/lv_templ.h](https://github.com/lvgl/lvgl/blob/master/src/lv_misc/lv_templ.h)
## Naming conventions ## Naming conventions
* Words are separated by '_' * Words are separated by '_'
@@ -15,17 +16,18 @@ Use [lv_misc/lv_templ.c](https://github.com/littlevgl/lvgl/blob/master/src/lv_mi
* prefer `typedef struct` and `typedef enum` instead of `struct name` and `enum name` * prefer `typedef struct` and `typedef enum` instead of `struct name` and `enum name`
* always end `typedef struct` and `typedef enum` type names with `_t` * always end `typedef struct` and `typedef enum` type names with `_t`
* Abbreviations: * Abbreviations:
* Use abbreviations on public names only if they become longer than 32 characters * Only words longer or equal than 6 characters can be abbreviated.
* Use only very straightforward (e.g. pos: position) or well-established (e.g. pr: press) abbreviations * Abbreviate only if it makes the word at least half as long
* Use only very straightforward and well-known abbreviations (e.g. pos: position, def: default, btn: button)
## Coding guide ## Coding guide
* Functions: * Functions:
* Try to write function shorter than is 50 lines * Try to write function shorter than is 50 lines
* Always shorter than 100 lines (except very straightforwards) * Always shorter than 200 lines (except very straightforwards)
* Variables: * Variables:
* One line, one declaration (BAD: char x, y;) * One line, one declaration (BAD: char x, y;)
* Use `<stdint.h>` (*uint8_t*, *int32_t* etc) * Use `<stdint.h>` (*uint8_t*, *int32_t* etc)
* Declare variables when needed (not all at function start) * Declare variables where needed (not all at function start)
* Use the smallest required scope * Use the smallest required scope
* Variables in a file (outside functions) are always *static* * Variables in a file (outside functions) are always *static*
* Do not use global variables (use functions to set/get static variables) * Do not use global variables (use functions to set/get static variables)
@@ -84,11 +86,4 @@ void lv_label_set_text(lv_obj_t * label, const char * text)
Use 4 spaces indentation instead of tab. Use 4 spaces indentation instead of tab.
You can use **astyle** to format the code. The required config flies are: `docs/astyle_c` and `docs/astyle_h`. You can use **astyle** to format the code. Run `code-formatter.sh` from the `scrips` folder.
To format the source files:
`$ find . -type f -name "*.c" | xargs astyle --options=docs/astyle_c`
To format the header files:
`$ find . -type f -name "*.h" | xargs astyle --options=docs/astyle_h`
Append `-n` to the end to skip creation of backup file OR use `$ find . -type f -name "*.bak" -delete` (for source file's backups) and `find . -type f -name "*.orig" -delete` (for header file's backups)