【云驻共创】作为一名程序员，怎样写出高效简洁的代码？

Hello，大家好，我是Dream。 经常有朋友问我，自己写的代码太乱，虽然功能都能实现但是写的并不简洁，让人一眼看上去就会很难受，那如何去写出简洁优雅的代码呢？那今天我就来和大家分享一下一些写代码的好习惯和小技巧，掌握这些小技巧，我相信写出简洁优雅的代码并不成问题，快来一起看吧！

一、为什么要注意代码的写法

代码的写法直接影响着程序的可读性、可维护性和可扩展性。好的代码写法可以使程序更易于理解和修改，减少出错的可能性，提高代码的质量和效率。写出简洁的代码是每个程序员都应该追求的目标。

二、如何正确的书写代码

当谈到如何正确的书写代码时，有几个关键点需要注意。
首先，代码应该易于阅读和理解。这意味着使用清晰的变量名和注释，以及遵循一致的代码风格。其次，代码应该是可维护的。这意味着使用模块化的设计，避免重复代码，并确保代码易于修改和扩展。最后，代码应该是高效的。这意味着使用最佳的算法和数据结构，并避免不必要的计算和内存使用。
为了编写高质量的代码，您应该始终遵循以下几个步骤：

1.计划和设计

在编写代码之前，我们应该花时间计划和设计我们的代码。这包括确定我们的目标，设计您的数据结构和算法，以及编写伪代码。

2.编写代码

在编写代码时，我们应该遵循一致的代码风格，使用清晰的变量名和注释，并确保我们的代码易于阅读和理解。

3.测试和调试

在编写完代码后，我们应该进行测试和调试。这包括编写单元测试和集成测试，并使用调试器来查找和修复错误。

4.优化和重构

一旦您的代码可以正常工作，我们应该考虑优化和重构。这包括使用更好的算法和数据结构，避免重复代码，并确保我们的代码易于维护和扩展。

3、 书写简洁优雅代码的小技巧

1.使用有意义的变量名

变量名应该能够清晰地表达变量的含义。使用有意义的变量名可以使代码更易于理解和维护。例如，使用“count”代替“c”可以使代码更加清晰。

list=['Python','Circle','is','ok']

2.避免重复的代码

重复的代码会使代码变得冗长和难以维护。可以使用函数或类来避免重复的代码，这样可以使代码更加简洁和易于维护。
如果从一个类中复制了一段代码到另一个类中，这段代码需要时不时的修改，那么就要花时间去修改所有包含这段逻辑的代码，无形中增加了维护成本和发生bug的几率。这时候就要着手消除和抽取重复的代码。消除重复的代码有一个三次法则：
1.第一次先写了一段代码。
2.第二次在另一个地方写了一段相同的代码。
3.再次在另一个地方写了同样的代码，这个时候就要赶紧去抽象消除这个问题了。

3.使用注释

注释可以帮助其他人理解代码的含义和目的。注释应该清晰、简洁，并且应该解释代码的目的和实现方式。

#表示只包含一个元素的元组，一定要在后面加逗号

a=(1)print(type(a))#整数

a=(1,)print(type(a))#元组

4.使用简单的语句和表达式

使用简单的语句和表达式可以使代码更加易于理解和维护。应该避免使用复杂的语句和表达式，因为它们会使代码变得难以理解和维护。

#求两个集合的差集

a={6,7,8}

b={7,8,9}print(a-b)

5.避免使用全局变量

全局变量会使代码变得难以理解和维护。应该尽量避免使用全局变量，而是使用局部变量或参数来传递数据。
全局变量有些时候是无法避免的，只能尽量减少全局变量。我能想到的主要有三个方面：
1、通过函数参数传递数据或指针。对于回调函数，通常有一个参数是自定义的数据指针，可以利用这个参数传递类指针或者自定义一个结构的指针。
2、只在某一个函数中使用的变量可以定义为局部静态变量（在函数内部定义，前面加static修饰）。
3、把全局变量定义成一个结构，定义一个全局的结构体变量。

6.使用适当的数据结构

使用适当的数据结构可以使代码更加简洁和易于维护，在大多数情况下，比不使用数据结构或使用不恰当的数据结构，能够更有效管理大量数据。例如，使用数组或列表来存储数据可以使代码更加简洁和易于维护。

7.使用函数和类

使用函数和类可以使代码更加模块化和易于维护。函数和类应该具有清晰的目的和功能，并且应该遵循单一职责原则。

class Person:

def __name(self):

print('私有方法')

8.使用异常处理

使用异常处理可以使代码更加健壮和易于维护。异常处理应该能够清晰地表达异常的类型和原因，并且应该提供适当的处理方式。

9.使用代码格式化工具

使用代码格式化工具可以使代码更加整洁和易于阅读。代码格式化工具可以自动调整代码的缩进、空格和换行符等格式。大多数编译器中都都会自带代码格式规范的工具，例如，Pycharm中的代码规范工具——Black。
安装的命令为

pip install black

可以在anaconda下的anaconda promtpt下、cmd命令行中输入该命令，也可以在pycharm中下方的terminal中输入命令进行安装。

10.遵循编码规范

遵循编码规范可以使代码更加一致和易于维护。编码规范应该包括变量命名、代码格式、注释和异常处理等方面的规定。

11.使用空格和缩进

空格和缩进可以让代码更易读。在编写代码时，应该尽量使用空格和缩进来分隔代码块和函数块。这样可以让代码更加清晰。和空行一样，空格的使用也没有强制性的规定，仅仅是为了增强代码的可读性。一般情况下，以下位置可以适当插入空格：
(1) 等号的前后；
(2) 数学运算符的前后，关键字和括号之间插入空格；
(3) 比较运算符的前后；
(4) 后面有代码的分号后面；
(5) 分割不同参数的逗号后面；为了和上下行的代码对齐，有时候需要插入两个空格；如果需要插入更多空格才能和上下代码对齐，通常会使用 tab 键。

12.遵循编码规范

编码规范可以帮助你写出更加规范和易读的代码。在编写代码时，应该遵循编码规范，比如使用统一的缩进、命名规范等。

13.使用版本控制

版本控制可以帮助你更好地管理代码。在编写代码时，应该使用版本控制工具，比如 Git，来管理代码的版本和变更。

14.不要重复造轮子

在编写代码时，应该尽量使用现有的库和框架，而不是重复造轮子。这样可以提高代码的效率和质量。
对于程序员个人来说，我觉得在程序员编程水平还比较初级的时候，多多造轮子可以提高自己的动手能力和编程能力，对于编程水平中等的程序员，我建议也是多多造轮子，以此来提高自己的编程能力，对于高手程序员来说，他在成为高手之前的那些日子里就是天天在造轮子，因为他那时候如果不多多造轮子(如果他那时候不拼命反反复复写代码)，那他现在也不可能成为高手！所以，对于高手程序员来说，此时，可以不必重复造轮子了，如果他是出于精进、精益求精或者是出于研究和学习的目的，那他也可以适当的偶尔的造轮子，那也是OK的。

15.测试代码

测试代码可以帮助你发现代码中的问题和漏洞。在编写代码时，应该尽量编写测试代码，以确保代码的正确性和稳定性。测试能够给我们信心，如果你的代码通过了测试，那么即便有再多的人使用你编写的程序，它也能正确地运行。通过测试，可确定代码面对各种输入时都能够按预想的那样工作。
测试是很多初学者都不熟悉的主题，作为初学者，并非必须为你尝试的所有项目编写测试，但参与工作量较大的项目时，应对自己编写的函数和类的重要行为进行测试，这样就能够更加确定自己所做的工作不会破坏项目的其他部分，如果不小心破坏了原来的功能，你马上就会知道，从而能够轻松地修复问题。相比于等到不满意的用户报告bug后再采取措施，在测试未通过时采取措施要容易得多。
Python标准库中的模块unittest提供了代码测试工具，单元测试用于核实函数的某个方面没有问题，测试用例是一组单元测试，这些单元测试一起核实函数在各种情形下的行为都符合要求。良好的测试用例考虑到了函数可能收到的各种输入，包含针对所有这些情形的测试，全覆盖式测试用例包含一整套单元测试，涵盖了各种可能的函数使用方式。

总之，写出简洁的代码需要程序员不断地学习和实践。通过使用有意义的变量名、避免重复的代码、使用注释、使用简单的语句和表达式、避免使用全局变量、使用适当的数据结构、使用函数和类、使用异常处理、使用代码格式化工具和遵循编码规范等技巧，可以写出更加简洁、易于理解和维护的代码。

本文参与华为云社区【内容共创】活动第22期 。

任务37：作为一名程序员，怎样写出高效简洁的代码？