ESP8266开发之旅 进阶篇⑤ 代码规范 —— 像写文章一样优美

授人以鱼不如授人以渔，目的不是为了教会你具体项目开发，而是学会学习的能力。希望大家分享给你周边需要的朋友或者同学，说不定大神成长之路有博哥的奠基石。。。

快速导航
单片机菜鸟的博客快速索引(快速找到你要的)

如果觉得有用，麻烦点赞收藏，您的支持是博主创作的动力。

1.前言

    之前，一直在跟大伙分享怎么去玩蓝牙模块，怎么去玩wifi模块，怎么去玩json，然后有很多小伙伴就留言各种问题或者说直接怼他的代码过来让我看，然后我就一脸懵逼（代码中到处各种abcd变量，各种一个方法几百行，也没有什么注释，我心中一万只万马奔腾）。所以就有了这次的主题，代码规范（当然，这是我自己的代码规范经验，只是借鉴经验），教了大家怎么去做东西，反而忽略了最基本的东西。
    特别是出来工作之后，我就觉得代码规范比做需求业务还要重要。
    首先，方便他人。一个项目往往是由多人一起完成的，代码规范，会让大家交流起来更加简单有效，别人接手你的代码也比较容易。
    其次，方便扩展。一个好的项目，代码还是得具有一定的扩展性，很多时候项目是迭代开发的，分层抽象还是很重要。
    最后，方便自己。很多开发人员都会有这种感觉，自己写的代码，过一段时间回来再看的时候，就会有点懵逼的感觉（往往就是因为代码不够规范，也没什么注释，连自己都看不懂了）。
    这次计划分三篇来分享，尽量概括常见的规范点，主题分为三部分：

• 工程代码规范
• 函数方法规范
• 兼容性规范

2.工程代码规范

    工程代码规范，主要是针对整个项目来规范。

2.1 文件命名

2.1.1 错误写法

• 博主还记得大学的时候非常喜欢用abcdxy这些单一的字母来命名文件，隔一段时间再去