LVGL应用代码规范与命名约定

"CODING_STYLE.md 是一份关于使用LVGL库进行编程时的代码风格和规范指南，旨在确保代码的一致性和可读性。" 在LVGL的编程规范中，有以下几个重要的方面： ### 文件格式 文件命名应参考`lv_misc/lv_templ.c`和`lv_misc/lv_templ.h`这两个模板文件。这些模板提供了正确的文件结构和编码风格的基础，开发者应该按照它们的样式来组织自己的代码。 ### 命名约定 - **单词间使用下划线`_`分隔**：例如，`my_variable_name`。 - **变量和函数名全小写**：如`height_tmp`。 - **枚举和#define常量全大写**：例如`MAX_LINE_NUM`。 - **全局名称（API）**：以`lv_`开头，接着是模块名，如`btn`, `label`, `style`等，然后是动作（对于函数），如`set`, `get`, `refr`等，最后是主题，如`name`, `size`, `state`等。 ### 类型定义 - **优先使用`typedef struct`和`typedef enum`**：而不是直接使用`struct name`和`enum name`，这样可以使代码更清晰。 - **`typedef struct`和`typedef enum`的类型名以`_t`结尾**：例如`my_struct_t`, `my_enum_t`，这有助于识别定义的类型。 ### 缩写规则 - **只对6个字符或更长的单词进行缩写**。 - **只有当缩写后单词长度至少减半时才缩写**。 - **只使用非常直白且广为人知的缩写**：例如，`pos`表示`position`, `def`表示`default`, `btn`表示`button`。 ### 编码指南 - **函数**： - 尽量将函数保持在50行以内，以便于理解和维护。 - 函数应有明确的目的，避免包含过多的功能。 - **注释**： - 每个函数、结构体和重要的变量都应该有注释，解释其功能、用途和参数。 - 注释应使用清晰的语言，描述代码的行为和预期效果。 - **代码结构**： - 使用适当的空格和缩进增强代码的可读性。 - 遵循一致的括号使用规则，例如K&R风格（控制结构的花括号放在行尾）。 - **错误处理**： - 应该对可能出错的操作进行检查，并提供适当的错误处理机制。 - **内存管理**： - 确保正确地分配和释放内存，避免内存泄漏。 遵循这些编码风格和规范，可以提高LVGL应用程序的代码质量，使其更易于阅读、维护和扩展。在团队合作项目中尤其重要，因为它能确保所有成员遵循统一的标准，减少误解和冲突。