1.从计划开始
编写更好代码的最好方法之一是从计划开始。在开始编码之前，请花几分钟时间思考一下你希望代码做什么。
不要认为你知道需要做什么而跳到编写代码中。花点时间真正了解手头的问题。
- 输入和输出是什么？
- 预期结果是什么？
- 从一个到另一个需要采取哪些步骤？
- 你需要什么数据结构？
- 有什么边缘案例需要考虑吗？
清楚地了解需要做什么，使你能够将你的想法转化为具体的计划。即使你开发的高级程序结构并不完美，你也会发现生成的代码更容易阅读，扩展代码的复杂性更容易管理。
2.写出有意义的变量和函数名称
写得很好的代码的标志之一是它易于阅读和理解。让你的代码易于阅读的很大一部分是使用有意义的变量和函数名。
为事物选择好名声很难。但即使在网络开发中也是如此。当人们试图理解你的代码时，你的变量和函数名称通常是人们首先看到的。
变量和函数名称应为：
- 描述性。
- 易于记忆和发音。
- 与代码中的其他名称一致。
要实现这一点，你应该：
- 使用描述性名称。
- 避免使用单个字母名称，除非上下文中的意思非常清楚。
- 避免使用神奇的数字。
- 决定命名惯例，然后坚持下去。
- 一如既往，评论你的代码。
当你为事物挑选名字时，问自己以下问题：
- 这个变量或函数是做什么用的？
- 它的名字描述了它的目的吗？
- 记住我什么时候发音容易吗？
- 它与代码中的其他名称一致吗？
如果你无法轻松回答所有这些问题，那么选择一个不同的名字可能是一个好主意。
3.编写小型模块化函数
较小的功能更容易测试，更容易调试，也更容易重用。它们还使你的代码更具可读性，因为每个函数的目的都很清楚。
重要的是要明白，代码模块化不是关于在代码中禁欲地追求极简主义。这是关于从你花在解决问题上的时间中受益。
要实现这一点，你应该：
- 通过赋予他们单一的责任来保持功能小规模
- 描述性地命名你的函数
- 避免副作用
- 明智地使用参数
4.注释
注释是提高代码可读性的好方法。使用注释来解释你的代码在做什么以及你为什么要这样做。
一个常见的惯例是使用TODO评论为自己留下需要做的事情的笔记：
// TODO: Implement login functionality
另一个常见的惯例是使用FIXME评论为自己留下需要修复的事情的笔记：
// FIXME: This code is not working properly
这是跟踪需要做什么的有用方法，它还使其他人很容易看到需要做什么。
重要的是要记住，注释应该用于提高代码的可读性，而不是使其更难理解。如果你发现自己写的评论比它正在评论的代码长，这表明你的代码不可读，应该重构。
5.使用空格提高可读性
除了缩进代码外，你还可以使用空格来提高其可读性。通过在代码行之间添加额外的间距，将使你的代码更容易扫描和理解。当你查看大块代码时，这特别有帮助。
6.DRY原则
DRY原理是良好编码最重要的原则之一。尽可能避免复制代码很重要。这节省了你的时间，因为你只解决问题一次，并且只需要在其他因素发生变化时更改解决方案的一个实现。
发生故障时，你只需要修复一个实现，因此DRY代码更容易维护，并且不太容易出错。
7.编写SOLID代码
SOLID是一个首字母缩略词，引用了五个关键的软件设计原则，由Robert C创造。Martin，敏捷软件开发宣言的创始人，也是Clean Code的作者。
SOLID的五项设计原则是：
- Single responsibility 原则。
- Open/closed 原则。
- Liskov substitution 原则。
- Interface segregation 原则。
- Dependency inversion 原则。
你不需要记住这些原则，但它们值得注意。当你开始编写更好的代码时，你可能会发现自己自然地遵循这些原则。
8.不要重新发明轮子
良好编码最重要的原则之一是不要重新发明车轮。这意味着你应该尽可能使用现有的库、工具和框架，而不是从头开始编写自己的代码。
遵循这一原则有很多原因。首先，它为你节省了时间。你不必编写已经编写的代码。其次，它减少了你必须维护的代码量。第三，它增加了其他人发现并修复现有代码中任何错误的可能性。
当然，这条规则也有例外。如果你需要一些还不存在的东西，你必须自己创造它。但一般来说，最好尽可能重用现有代码。
开启掘金成长之旅！这是我参与「掘金日新计划 · 2 月更文挑战」的第 4 天，点击查看活动详情
