编程中的良好习惯

文章目录

• 一、工具类
• 二、资源类
• 三、方法类

引言：虽然这是我们工控软件基础的一个作业，但我最后还是把这个整理归纳出来，方便可以和大家交流。这些也是我的一个经验总结，难免会有片面之处，日后也会持续更新，希望大家多多支持（QQ：56672035）

一、工具类

1. IDE
   我们首要的选择就是需要选择一个成熟的IDE，使用人数多，受众面广，维护性好、协同合作性强等特点。其实说到底还是选择你使用起来最舒服的效率最高的就可以。比如一些我之前使用过的常见的就是：C++开发使用Visual Studio、Python开发使用Pycharm或者VS Code、Java使用Eclipse，单片机之类的得看芯片和类C语言（个人观点，不喜勿喷）。
   说完了IDE，其实选择完IDE之后，插件和社区等功能也要合理利用好，找到一个合理的插件可以大大地提高我们的工作效率，留意社区可以帮助我们解决我们编程中遇到的各种难题和BUG。
2. Notepad++
   这是一个文本编辑器，但这并不是一个简单意义上的编辑器，它可以支持语法高亮，支持脚本，能够缩进折叠，更强大的是支持宏操作和正则化操作。Notepad++不仅仅方便我们预览编辑各种文本文件，甚至合理设置好也可以编译调试，甚至成为我们常用的IDE。
   下载地址：https://notepad-plus.en.softonic.com/
   
3. Git
   Git相信很多人都知道他是一个分布式版本控制软件，归纳起来Git的主要优点有三个：

• 文件版本管理。
  作为版本管理系统诞生的Git，最重要的是可以帮助团队进行文件管理，各种源代码和文档等。
• 代码评审。
  代码评审作为软件开发流程中重要的一环，是项目顺利进行提供有效的保障，使用过Github的人对Pull Request应该不会陌生，如果高效进行代码就是另一个问题了。
• 持续集成。
  持续集成作为软件的开发和发布流程中最重要的一环，通过进行单元测试、自动化测试和自动构建发布，可以非常容易发现和改正Bug, 通过钩子(Hook)，Git可以和构建工具（如Jenkins）结合构建持续集成环境。

大多数人可能会觉得入门门槛高，这里我提供两个参考文章和一个实验链接：
1️⃣：史上最简单Git入门教程
2️⃣：Git使用教程：最详细、最傻瓜、最浅显、真正手把手教！
3️⃣：实验楼-Git 与 GitHub 入门实践

4. Everything
   Everything 是一个文件名搜索工具。它小巧免费，支持中文，支持正则表达式，可以通过 HTTP 或 FTP 分享搜索结果。程序员的电脑文件很多，有的时候个别文件难以找到具体位置，这时候Everything就派上用场了，直接搜文件的名字就可以找到具体位置了，而且还支持正则表达式搜索、路径搜素、模糊搜索和文件筛选，而且，搜索的效率和速度比windows下自带的资源管理器的搜索好的多。
   下载地址：https://www.voidtools.com/zh-cn/

二、资源类

这一部分可能和编程离题太远，但是我觉得一个真正厉害的程序员其实是不仅仅满足于当下的技术的，需要树立终身学习的观念，需要不断学习，补充新的知识和技术。

1. 电子书
   现在来说，我常用的几个链接就是：
   ①搜书VIP-电子书搜索，这个是一站式搜索，集合了很多的电子书资源网站。网站名字变蓝色，可以点链接查看；字体变红，说明没有找到；字体黑色，表示未查询或者在查询中。
   ②ePUBee电子书库，最大的电子书库，在线电子书管理，这个应该是我已知的找书最全的网站了，之前还是免费的，现在就得错峰下载或者充值了
   ③最后剩下的最直接的方法应该就是找淘宝了，但是需要提供图书的准确信息，就需要ISBN号、出版社、出版日期等信息，这些可以通过全国图书馆参考资源联盟进行查询
2. 论文
   ①iData-知识检索，这个一般查询国内或者知网上常见的论文
   ②sci-hub，这个方便搜索英文文献，因为是国外的服务器，可能速度稍微有点慢
3. 其他比较重要的一些就是数据集，镜像网站之类的了，这些也是很重要的。这些日后再做更新

三、方法类

这一部分包括我们在程序调试过程中经常会遇到的一些问题

1. 宏定义。能用宏的我们尽量用宏，一个工程的宏定义最好写在一个文件里，方便修改，不要零散分散在工程里的各个文件中。
2. 函数封装。编程时要勤于封装函数，将各个功能尽可能封装成可重用性较好函数；要勤于写注释，对于封装好的函数，写一下函数的功能，入口及出口参数，会对其他使用你代码的人帮助很大。
3. 断点调试。单片机编程时，要善于用断点来调试bug，学会使用变量区来观察变量。
4. 重要变量私有化。对于一些重要的变量，最好设为私有变量，提供接口函数来修改。只要对外接口保持不变，类的内部变化不会影响到用户代码的变化。这就说明了面向对象中封装的重要性，而private提供了封装。
5. 内存管理。单片机编程时，注意内存的管理，运行完不再需要的内容及时清掉，不能消耗过多的资源
6. 文档撰写。在工程过大的时候，可以建立树目录，或者编写readme等文档，方便日后了解各个文件的作用和编写目的。
7. 返回值。写函数的时候可以留心写一些返回值，可以方便后期调试。
8. 异常处理。书写try-except结构可以方便后期调试，了解代码出错所在。
9. 如果语句较长，可以将它写成多行，可以方便阅读，使得代码一目了然。