后端笔记 | 高质量编程

275 阅读3分钟

高质量编程:

高质量定义:

  1. 边界条件考虑是否完备

    • 在编写代码时,应充分考虑各种可能的输入值及其边界情况,确保程序在极端或不常见的输入下也能正确运行。
  2. 异常情况处理,稳定性保证

    • 对于可能出现的错误和异常,应该有妥善的处理机制,如使用异常处理语句(try-catch),确保程序即使遇到问题也不会崩溃,并能够给出合理的错误提示或日志记录。
  3. 易读易维护

    • 代码应该是清晰和简洁的,遵循一定的编码规范,比如命名规则、注释习惯等,使得其他开发者可以轻松理解代码的功能和结构。

代码格式:

统一缩进风格(如使用空格还是制表符,以及具体的缩进数量)。 保持一致的命名约定(如使用驼峰式命名、匈牙利命名法等)。 控制行长度,避免过长的行影响阅读。 使用空白行分隔不同的逻辑块,使代码结构更加清晰。 对于较长的表达式或语句,适当进行换行以提高可读性。

编程原则:

简单性:

编写的逻辑尽可能简单

可读性:

你的代码运行周期很长,实际上代码上线以后不会被删掉,而是一直被修改

所以可读性在以后得维护中很重要

生产力:

注释:

image-20241108141023918

注释的重要性

解释代码作用:对于复杂的算法或业务逻辑,适当的注释可以帮助其他开发者更快地理解代码的目的。 解释函数常量功能:对于函数和常量的定义,简短而准确的注释可以帮助使用者了解其用途和用法。 解释代码如何做:当代码实现较为复杂时,通过注释说明每一步的具体操作可以帮助读者更好地理解实现过程。 解释代码实现的原因:有时候选择某种特定的实现方式是为了满足特定的需求或解决某个具体的问题,这时候注释可以用来解释为什么选择了这种方式而不是其他。 解释代码什么情况会出错:对于容易出错的地方或者有特殊要求的操作,提供注释可以提醒未来的开发者注意这些潜在的风险点。

作用

1,。解释代码作用

解释函数常量功能

2.解释代码如何做的

3.解释代码实现的原因

4.解释代码什么情况会出错

代码格式

image-20241108141212792

命名规范:

image-20241108142313680

image-20241108142934813

image-20241108143111535

控制流程:

image-20241108143250061

image-20241108143303438

错误处理:

image-20241108143648100

复杂错误

image-20241108143748007

image-20241108144250869

panic

image-20241108144314921

recover