最新消息关于广西养老金补发方案是什么

核心目标让别人（以及未来的你）快速看懂代码逻辑、轻松改 bug、安全扩展功能，不是写 “能跑就行” 的代码。下面分成规范、结构、命名、注释、重构、工具等维度，简单好落地。

一、命名最重要，优先做好

好的命名可以减少一半注释

1. 见名知意，用业务词汇，不要简写、拼音、无意义单词

   • ❌ a, tmp, data, func1, sz
   • ✅ userOrderList, calculateTotalPrice, isLoginSuccess

2. 遵循统一大小写规范（团队统一）

   • 变量 / 函数小驼峰 getUserInfo
   • 类大驼峰 UserOrderService
   • 常量全大写下划线 MAX_RETRY_COUNT

3. 布尔变量尽量用 is/has/should/can 开头isValid、hasPermission
4. 避免双重否定不要 isNotInvalid

二、代码格式与排版

1. 统一缩进（2 空格 / 4 空格，不要混用 tab 和空格）
2. 合理空行逻辑块之间空一行，不要堆成一大块；不要多余空行泛滥
3. 一行不要太长建议单行控制在 80–120 字符，超长表达式换行
4. 对齐风格统一，括号风格统一（比如 Allman / K&R，团队选定就不变）
5. 不要写 “一行神仙代码”，不要把多个逻辑挤压在同一行

   # ❌</p><p>res = [x for x in list if x>5 and (x%2==0 or flag)]</p><p># ✅ 复杂条件拆变量</p><p>is_greater = x > 5</p><p>is_even_or_flag = (x % 2 == 0) or flag</p><p>

三、控制复杂度函数、类要 “单一职责”

单一职责一个函数 / 一个类只做一件事

1. 函数短小一个函数尽量控制在几十行以内。如果函数很长，说明可以拆分。
2. 函数参数不宜过多参数超过 4–5 个，考虑封装成对象 / 结构体。
3. 减少嵌套深度if 嵌套、for 嵌套尽量不超过 3 层；优先提前 return减少嵌套

   // ❌ 深层嵌套</p><p>if (user != null) {</p><p> if (user.isVip()) { ... }</p><p>}</p><p>// ✅ 卫语句提前返回</p><p>if (user == null) return;</p><p>if (!user.isVip()) return;</p><p>

4. 避免超长链式调用、过度嵌套三元表达式
5. 遵循 DRY 原则Don’t Repeat Yourself，重复逻辑抽成公共方法，复制粘贴是维护灾难

四、注释只补代码说不出来的信息，不要复述代码

注释的原则代码告诉你做什么，注释告诉你为什么、背景、特殊约束

• ❌ 坏注释i++ // i加1、// 判断用户是否登录（代码本身已经写了 isLogin()）
• ✅ 好注释

  • 为什么这么实现历史原因、产品特殊规则、兼容旧版本
  • 风险点、边界限制// 第三方接口限制单次最多传20条
  • 待优化标记// TODO: 后续替换为缓存方案
  • 复杂算法思路

• 优先文档注释给公共类、对外接口写文档，说明入参、返回值、异常、使用示例
• 及时清理过期注释改代码不改注释，注释会变成谎言

五、控制分支与条件，降低认知负担

1. 复杂条件抽成命名变量把一大串 && || 提取成语义化布尔变量
2. 优先使用枚举 / 常量代替魔法值

   • ❌ if(status == 1)
   • ✅ if(status == OrderStatus.PAID)

3. 过多 if-else 分支考虑策略模式、查表、工厂模式，消除巨型 if 块
4. switch /match 不要漏分支，增加 default 兜底和日志

六、模块化、分层、低耦合高内聚

• 高内聚模块内部功能紧密相关；低耦合模块之间尽量少依赖
• 分层清晰比如 Controller → Service → Dao，各司其职，不要在接口里直接写 SQL
• 依赖抽象，不要依赖具体实现（面向接口编程）
• 减少全局变量、静态变量；全局状态是调试和维护大坑
• 依赖显式传入（依赖注入），不要在函数内部偷偷创建依赖对象

七、错误处理、日志、边界

1. 异常要有明确含义，不要统一捕获 Exception 然后吃掉不处理
2. 日志带上上下文id、请求号，方便定位，不要只打印 出错了
3. 显式处理异常场景、空值、边界，不要依赖语言默认行为
4. 失败场景有说明，返回值语义清晰，避免一个返回值承载多种含义

八、命名空间、包结构、文件组织

• 文件按业务 / 领域划分，不要按类型全部堆在一起（例如不要所有 model 放一个文件夹）
• 一个文件尽量只放一个主类；辅助工具类单独放
• 目录结构稳定，新人打开项目能猜到代码在哪

九、测试 & 重构习惯

1. 写单元测试测试本身就是最好的使用示例，改代码时防止隐性破坏
2. 持续小重构不要堆到完全无法维护再大改；先写测试，再重构
3. 提交粒度小，commit message 规范清晰（比如约定 feat/fix/refactor/docs），方便追溯改动目的

十、工具与规范落地

1. 静态检查ESLint、Pylint、Sonar、clang-tidy，自动发现格式、复杂度、坏味道
2. 格式化工具Prettier、black，统一格式，减少 “格式争论”
3. 代码评审 Code Review团队互相把关，统一风格
4. 文档README 写清楚项目启动、模块说明、核心流程

十一、常见反面例子（代码坏味道）

• 巨型函数、上帝类（一个类包揽所有逻辑）
• 魔法数字、神秘字符串
• 深层循环嵌套、大量 flag 标记变量
• 重复复制粘贴代码
• 命名随意，中英文混杂、缩写随心所欲
• 大量全局变量、可变共享状态
• 注释泛滥或者注释过期
• 吞掉异常、无日志

---

一句话总结顺序（上手优先级）

先把命名写好 → 排版整洁 → 拆小函数、减少嵌套 → 消灭魔法值和重复代码 → 写必要注释和测试 → 用好工具规范如果你想要，我可以给你一份可直接发给团队的代码规范清单，或者用 Python / Java / Go 给你写一组【坏代码 + 优化后对照示例】。