如何写出可读性高的代码

本文探讨了编写高效、可维护代码的最佳实践,包括函数的单一职责原则,避免长函数和复杂条件表达式,使用异常处理,以及如何通过重构提升代码质量。强调了函数命名、参数管理、错误处理和多态运用的重要性,并提倡通过预检和卫语句简化逻辑。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  1. 函数尽量短小,并且只做一件事,即抽象层次要相同。

  2. if,else,while,try,catch,finally里面的代码块应该只有一行,并且配上具有说明性的名称。

  3. 函数的参数不要超过3个,如果超过3个,则创建对象来作为入参。

  4. 函数要么做什么事情,要么回答什么事情,即要么设置值,要么返回值。不要两件事情都做,避免逻辑混乱。

  5. 使用异常替代错误码,因为异常可以将错误处理代码从主路径代码中抽离。

  6. 很难一次性就写出完美,第一次写完可以粗糙点,不要有完美主义,第二次不断重构即可。

  7. 分解条件表达式,将复杂的的条件提炼出新的函数。

  8. 将可以合并的条件表达式进行合并。

  9. 合并重复的条件片段,抽离出变化和不变的内容。

  10. 使用break和return,卫语句,提前返回函数。

  11. 使用多态替代switch表达式。

  12. 给函数取一个好名字,想办法将注释变成函数名称

  13. 函数入参尽量使用对象,保证入参的简短。

  14. 将查询函数和修改函数分开,一个负责查询,一个负责修改

  15. 用异常取代错误码,可以预先检查的条件,可以在调用函数之前先做检查,即提前返回函数。

  16. 如果函数做了类似的工作,那就建立单一的函数,通过参数表达不同的值

  17. 如果参数可以通过函数获取,则去掉该参数,改为通过函数获取。

  18. 如果函数没有被其他类使用,则设置为private。

写出质量的Vue代码,以下是一些建议和方法: 1. 组件复杂性的判断:虽然没有一个明确的标准来判断一个组件是否复杂,但可以从第三方角度出发,考虑一个相对经验水平较低的程序员能否轻松理解代码。如果代码难以理解,可以考虑进行拆分。另外,如果非要给一个机械的判断标准,建议将代码控制在200行以内[1]。 2. 使用Vue3的Hooks:Vue3的Hooks机制可以帮助我们更好地组织代码,将功能相关的代码聚合在一起。与Vue2相比,Vue3的Hooks写法更容易将相关联的代码聚集在一起,这样可以使代码更清晰、易于维护。 3. 规范组件结构顺序:为了让代码更加规范和易读,可以约定一套组件结构顺序的规则。例如,将<template>放在最上层,<script>放在中间,<style>放在最后。此外,还可以约定<script>内选项和钩子函数的书写顺序。 4. 单一职责原则:每个组件应该只负责一个功能,这样可以使代码更加模块化和可维护。如果一个组件包含多个功能,可以考虑将不同功能的代码拆分到不同的组件中。 5. 代码可读性和可维护性:通过使用有意义的变量名、注释以及良好的代码缩进和格式化等方式,可以提代码可读性和可维护性。此外,遵循一致的命名约定和代码风格也是优化代码质量的重要方面。 6. 使用Vue的特性和最佳实践:熟悉Vue框架的特性和最佳实践,例如使用computed属性来处理计算逻辑、使用Vuex来管理全局状态等,可以帮助我们写出质量的Vue代码。 综上所述,要写出质量的Vue代码,需要考虑组件复杂性、使用Vue3的Hooks、规范组件结构顺序、遵循单一职责原则、提代码可读性和可维护性,以及使用Vue的特性和最佳实践。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值