编码规范

代码结构

neuron
├── cmake
├── deploy
├── ft        
├── include
├── persistence
├── plugins   
├── simulator 
├── src
└── tests

其中cmake存放交叉编译文件，ft存放功能测试文件，include存放对外头文件，plugins存放南向插件，simulator存放 modbus 模拟器相关文件， tests存放单元测试文件。

编码规范

Neuron 代码以高可读性为原则，有以下规范要求：

• 宏全大写，除了宏，其他均使用小写。
• 变量，函数，结构体等名字是有用意义的英文单词，单词间用下划线隔开。
• 保持良好的命名风格，能做到命名即注释，不添加无效的注释。
• 每个C文件应该是一类强相关功能的最小集合。
• 只有需要对外导出的函数，变量等，才添加到头文件中。
• Neuron 使用 clang-format 进行代码格式化，clang-format 文件在 Neuron 根目录。
• 函数尽可能的短小，一个函数只实现一个功能，函数逻辑清晰（一段时间后再去看之前写过的代码，也能很容易看懂），函数最长不超过 80 行。