如何学会规划自己的代码

如何学会规划自己的代码

有很多人遇到开发需求时都会急急忙忙的开始写代码，生怕浪费一丁点时间，通常是想到什么写什么，没有一丁点规划。

动脑子想想，这样做真的对吗？

随意写的代码，面向结果编程，这样写出的代码，往往质量奇差，缺少灵活性，可扩展性以及可维护性。当我们想进一步扩展时，就好像面对一个毛线球一样，很难下手，往往要花大量时间理清思路才行。从长远看来，这种没有规划随意写出的代码，虽然前期的时间花费的少，但是后期会花大量时间在复杂的逻辑上，这样是得不偿失的。

所以如何正确的规划好我们的代码呢？能够像积木一样可扩展，又像摩天大厦一样稳定。

1 从最基础出发

想想代码里有那些内容吧？

变量 数据类型 类 方法 这些“玩意”通用的是都有一个名字。

所以第一步 是把名字取好。

很多人看到这里，觉得“这很简单呀，有什么难得，遂跳过。”

其实把名字取好有很多讲究。

变量名用骆驼命名法 即 variable或者 redColor 这种形式的，看起来错落有致，并且首字母小写表示变量是“小型”的数据和类区别。通常为名词。如果是bool类型的则通常加上“is，has”，即hasReturn。

私有变量通常在前面加上“_”或者“m__” 私有变量是比较特殊的变量，表示在其他类里面无法使用这个变量，用该符号为前缀能够一目了然。

类名用帕斯卡命名法 即 Test或者TestColor 这种形式，通常为名词，每个单词的首字母大写。

方法名用帕斯卡命名法 即Play或者GetResult 这种形式，通常为动词。

问题：为啥方法名和类名的命名法相同，这里有什么妙处？

回答：主要是和变量区分开，然后是类和方法内部都可能有变量，可以通过名字.来获得变量，而变量明显不行。

初次之外，属性、命名空间和方法名相同，使用帕斯卡命名法。

还有一点，名要达意，这也很重要，一定要保证你取得名字是最适合表述正确意思的，这很重要。

2 做好前期准备

很多人觉得前期准备浪费时间，但是你真的知道前期准备给我们带来了什么好处吗？

首先看看什么是前期准备

第一步把业务逻辑理顺

做一个庞大的系统前，里面通常潜藏着很多逻辑，提前理顺，会比在写代码的过程中去理顺要好的多。因为写代码时，尽可能的关注实现，而不去关注逻辑。这样能够专心于一点，不容易被复杂的逻辑打断思路。

遇到复杂的逻辑，尽可能的把逻辑写下来。用文字或者伪代码。把逻辑分为多个步骤，这样我们可以分而治之，面对其中一小部分比整体好容易的多。

同时把这里步骤写下来有利于我们对进度的把控。

3 重构

重构绝对不是写完才进行的，而是只要你发现你的代码可以重构，那就马上进行重构，除非你知道这些代码一定会删除。

花时间重构比抓紧时间写完这个项目更加重要，是因为重构会有益于提高写完项目的速度，并且能够提高代码的质量。

做一个比喻：重构就像搭积木，花点时间把大的积木放在下面，比你随意放积木，但是后续必须，小心翼翼的防止积木散架效率要高得多。

4 代码质量

如何提高代码质量是所以新手的难题。很多人也许知道答案，比如使用设计模式、提高代码的扩展性和灵活性、松耦合等等。

但是一到写代码的时候不知道怎么办了？

1. 规范和代码风格：使用一致的代码风格和规范，如统一的缩进、命名规则、注释等，可以使代码更易于阅读和理解。遵循通用的代码风格指南，如Google代码风格指南或PEP 8（Python编码风格指南）。
2. 计划和设计：在开始编写代码之前，先进行良好的计划和设计。搞清楚需求，考虑系统的架构和设计模式，绘制流程图或类图等，以指导代码的实现。
3. 分而治之：将大型任务分解为小而可管理的子任务。这有助于提高代码的可读性、可维护性和测试性。通过模块化和函数封装，使代码更具可复用性。
4. 单元测试：编写有效的单元测试来验证代码的正确性。单元测试可以帮助捕获潜在的错误，并提供文档和示例，以使代码更易于理解和修改。
5. 代码复审：请其他开发人员对你的代码进行复审。代码复审可以发现潜在的问题、提供改进建议，并促进团队的知识共享和学习。
6. 学习和实践：不断学习编程技术和最佳实践。阅读优秀的代码、参与开源项目、参加培训和编程社区等，可以拓宽视野，改善编程能力。
7. 重构和优化：随着经验的积累，不断改进和优化代码。重构是指通过改进代码结构、减少重复代码、提取公共函数等方式来改善代码质量。
8. 错误处理和异常处理：考虑各种可能的错误和异常情况，并合理处理。良好的错误处理可以提高代码的鲁棒性和可靠性。

看起来要求很高对吗？

但是 其中1、2、3、6、7我们以及说过了。8只需要检测是否为null或者使用try catch进行处理，防止代码报错就可以了。

4 单元测试也很简单，也就是进行测试检查是否有可能出现错误，并且提高文档说明。

总结：不要把规范代码看成非常复杂的事情，其实不断实践中是很容易学会的，并且也不必强求和别人的规范相同，只需要发现自己合适的代码风格和习惯即可