1.开发步骤
本次工程实践是基于ESP-WROVER-KIT开发板的数据采集系统，ESP32开发板通过 USB 连接到开发主机（开发主机可以是 Linux、Windows 或MacOS操作系统），开发主机上有 ESP-IDF (乐鑫 SDK)、编译器工具链和项目代码。主机先编译代码生成可执行文件，然后电脑上的工具把生成的文件烧到板子上，然后板子开始执行文件，最后通过超级终端你可以从主机查看日志。由于交叉编译环境搭好之后，乐鑫提供了很多源码，主要是C语言写的代码。故从乐鑫的ESP-IDF中找出一套WIFI相关的源代码进行分析。
2.分析源代码目录结构
从乐鑫的ESP-IDF下载的WIFI模块，由许多小的模块组成，共同实现WIFI功能。包括低功耗模块，探测模块，文字处理模块，每个模块命名采用简单易懂，描述命名规则的名字来替代。在开发前先看下README，对整个WIFI模块的实现有个大致的了解。
- WiFi为整个源代码包的名称，由目录模块可知，WiFi由很多小的模块组成，包括低功耗，探测网络信号等，本次主要分析其中的Getting_started下的c语言代码，其余模块代码结构风格类似。
每个小模块的代码目录结构：
- main存放项目的所有源代码
- Makefile文件:文件中包含项目的编译信息
- CMakeLists.txt:存放Cmake编译信息
- build:存放项目构建所必须的库
3. 文件名、类名、函数名、变量名等命名
- 函数名
和变量一样，函数名称也应具有说明性。函数名应使用动词或动作性名字, 采用Snake Case命名法，这是书写复合词或短语的一种惯例（practice）。复合词或短语中的各个单词之间用 下划线 （_）分隔并且没有空格。复合词中的每一个单词的首字母通常都是小写的，并且复合词的第一个字母既可以是大写的又可以是小写的，例如：“foo_bar”和“Hello_world”。一般认为 Snake Case 的可读性要比 Camel Case 要强。
- 变量名
变量命名分为两种，对于普通变量，也采用下划线连接单词的命名方法，变量名为小写，对于宏定义，命名规则与普通变量命名相同，但是却换成了大写字母，以便于区分。
4.接口定义规范
即一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。实现一组函数供别人使用，就是提供接口；使用别人提供的函数，就是调用接口。在下载的源码包中，将代码实现和接口申明放在两个文件下。方便用户的使用，同时代码简洁，方便用户阅读。
在编写代码加载头文件
5、项目代码风格
- 注释
由于项目比较大，故写每一个模块的时候都有注释，方便阅读和使用接口，以及项目的对接。
-
代码缩进
良好的代码缩进能展示出代码的逻辑，方便阅读和理解。
- 代码实现和接口分开
6．模块测试
每个模块都需要测试，测试的方法有很多，本项目可以通过添加printf语句输出进行测试.
7、列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则
- 命名不够严谨，直接A,B,C，不方便阅读
- 没有写注释，别人很难看懂你的代码
- 没有缩进，代码一团乱，找不出代码逻辑
- 开发文档没有，项目很难被接手
- 在不同的代码风格中, 语言内置关键字和符号周围会分布有不同数量的空格, 没有使用空格
8、总结同类编程语言或项目在代码规范和风格的一般要求
- 1) 空行
空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序会多消耗一些纸张，但是值得。
规则一：定义变量后要空行。尽可能在定义变量的同时初始化该变量，即遵循就近原则。如果变量的引用和定义相隔比较远，那么变量的初始化就很容易被忘记。若引用了未被初始化的变量，就会导致程序出错。
规则二：每个函数定义结束之后都要加空行。
总规则：两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。
- 2) 空格
规则一：关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像
if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。
规则二：函数名之后不要留空格，应紧跟左括号(，以与关键字区别。
规则三：(向后紧跟；)、,、;这三个向前紧跟；紧跟处不留空格。
规则四：,之后要留空格。如果;不是一行的结束符号，其后要留空格。
规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如
=、==、！=、+=、－=、*=、/=、%=、>>=、<<=、&=、^=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、^ 等双目运算符的前后应当加空格。
注意，运算符“%”是求余运算符，与 printf
中
%d 的“%”不同，所以 %d 中的“%”前后不用加空格。
规则六：单目运算符
!、~、++、－－、－、*、& 等前后不加空格。
注意：
- 这里的“－”和规则五里面的“－”不同。这里的“－”是负号运算符，规则五里面的“－”是减法运算符。
- 这里的“*”和规则五里面的“*”也不同。这里的“*”是指针运算符，规则五里面的“*”是乘法运算符。
- 这里的“&”和规则五里面的“&”也不同。这里的“&”是取地址运算符，规则五里面的“&”是按位与运算符。
- 总之，规则六中的是单目运算符，而规则五中的是双目运算符，它们是不一样的。
规则七：像数组符号[]、结构体成员运算符.、指向结构体成员运算符->，这类操作符前后不加空格。
规则八：对于表达式比较长的
for 语句和
if 语句，为了紧凑起见，可以适当地去掉一些空格。但
for 和
if 后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。例如：
for (i=0; i<10; i++) for 和分号后面保留空格就可以了，=和<前后的空格可去掉。
- 3) 成对书写
成对的符号一定要成对书写，如 ()、{}。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。
- 4) 缩进
缩进是通过键盘上的 Tab 键实现的，缩进可以使程序更有层次感。原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。
- 5) 对齐
对齐主要是针对大括号{}说的：
规则一：{和}分别都要独占一行。互为一对的{和}要位于同一列，并且与引用它们的语句左对齐。
规则二：{}之内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不同的继续缩进。
还有需要注意的是，很多编程软件是会“自动对齐”的，比如：
#include <stdio.h>
int main(void)
{
if (…)
return 0;
}
写完 if 那一行后，按回车，此时光标在括号的右边，而此 if 下的大括号要写在与 if 左对齐的正下方，通常我们是按一下 Backspace 键使光标停在与 if 左对齐的正下方。但事实上我们不需要这样做，我们直接输入大括号即可，系统会自动对齐到与 if 左对齐的正下方。再接着看：
#include <stdio.h>
int main(void)
{
if (…)
{
while (…)
}
return 0;
}
写完 while 那一行后，按回车，此时光标不是停在与 while 左对齐的正下方，同样，我们不需要按 Backspace，直接输入大括号即可，系统会自动对齐到与 while 左对齐的正下方的。
此外编程软件还有“对齐、缩进修正”功能。就是按
Ctrl+A 全选，然后按
Alt+F8，这时程序中所有成对的大括号都会自动对齐，未缩进的也会自动缩进。不管是在编程过程中，还是在编写结束完之后，都可以使用这个技巧。但如果完全按照规范写，那根本就不需要这个技巧，所以，这只是一个辅助功能。
- 6) 代码行
规则一：一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。
规则二：if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。
- 7) 注释
C语言中一行注释一般采用//…，多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下，源程序有效注释量必须在
20% 以上。虽然注释有助于理解代码，但注意不可过多地使用注释。
规则一：注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多会让人眼花缭乱。
规则二：如果代码本来就是清楚的，则不必加注释。例如：
i++; //i加1
这个就是多余的注释。
规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。
规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。
规则五：每一条宏定义的右边必须要有注释，说明其作用。
