如何写出好的代码

85 阅读2分钟

什么样的代码是好代码?

  • 可读性高 代码容易理解,不晦涩。

  • 可扩展性 易于后期扩展,对于新功能只需要少量开发调整。

  • 性能优秀 利用很少的资源,实现复杂的功能。

可读性高

代码不仅仅是给机器阅读的,还是要给人看的。

如何写出可读性的代码?

  • 变量和函数命名要尽可能反映本身场景,而不需要写注释去说明,但是要仅能简短。

  • 代码目录要规范,根据功能和用途确定代码目录,要尽可能细化。

  • 废弃代码逻辑片段要及时删除,避免误导其他人。

  • 大功能函数要拆分成一个个小函数体,且内容要尽可能少于20行。

  • 避免过多的if逻辑判断。

  • 不要重复造轮子,要复用前辈的代码。

  • 确保可读性的情况下,用极少的代码完成复杂的逻辑。

可扩展性

一份耕耘多分收获。

如何写出扩展性代码?

复用,每定义一个函数和自定义变量,要考虑能不能被其他地方或其他人使用到,或者将来使用到。

对功能解耦,把一个大的功能拆分一个一个小的功能点,去实现小的功能,再由小功能组合成大功能。

对需求功能拆分,剥离出通用的功能,使这部分功能可以被其他场景复用。

性能优秀

对资源的使用要足够吝啬。

  • 变量要小,按需存储,减少循环次数。

  • 函数传值,如果数据量大,要使用引用传值,减少数据copy和内存回收效率。

  • 数据库查询的数据要少,加工数据的逻辑要利用数据库的资源。

  • 减少对数据库查询的次数,尽量在一次取出全部需要的数据。

  • 利用计算机多核心的优势,改串行为并行。

  • 合理的利用缓存,避免慢io设备的频繁操作。