返回顶部
t

tvs-clean-code

代码清洁与整理,并添加增强用户理解的注释,让代码意图清晰、自解释,大幅降低阅读和维护的认知成本。

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.0
安全检测
已通过
113
下载量
0
收藏
概述
安装方式
版本历史

tvs-clean-code

# 代码清洁与整理指南 核心目标: 让代码**意图清晰、自解释**,大幅降低阅读和维护的认知成本。 主动询问,若用户未指定要清理哪些代码,就要主动询问要清理的代码的文件路径,或者某些模块,某些目录。 ## 优先级最高的清理原则(先做这些,收益最大) 1. **去除无意义的包装层和冗余代码**(最常见、最高优先级) - 多余的单行箭头函数 / 简单 setter 包装 - 只用一次且名字没增加信息的中间变量 - 不必要的解构 + 重新组装对象 - 能用可选链 `?.` / `??` 解决的复杂条件判断 2. **禁止把核心业务逻辑分散到副作用钩子中** - 坏:`handleSubmit() → 改状态 → watch 监听到状态 → 执行保存` - 好:`async handleSubmit() { 设置状态 → await 保存 → 更新状态 }` - 原则:能写成顺序代码的,尽量不要拆成「动作 + 监听」 3. **命名必须表达意图而非实现细节** - 差:`handleData`、`changeStatus`、`doSubmit` - 好:`submitFormAndNotifyTeam`、`toggleFavorite`、`formatPriceWithCurrency` 4. **必须补充关键注释** 至少要注释: - 所有的响应式变量,函数,特别是核心业务函数 - 复杂的业务规则 / 计算逻辑 - 重要分支的「为什么」 - 边界情况 / 特殊处理的原因 - 难以从名字一眼看出的副作用 ## 重要但次优先的改进点 - **结构与现代风格调整** - 函数过长(>30–40行)→ 拆成单一职责小函数 - 魔法值 → 抽取为命名常量(优先用 const enum / as const) - 嵌套过深(>3层)→ 优先使用早返回(guard clause) - 重复逻辑 → 抽取为 composable / util / shared hook - **顺序与分组规范** - 推荐顺序(从上到下): 1. import(分组:第三方 → @/别名 → ./相对路径) 2. 类型 / 接口 / const enum 3. 常量 / 配置 4. ref / reactive / 计算属性(数据) 5. 核心业务函数(按调用频率或重要性排序) 6. 事件处理函数(handleXxx) 7. 生命周期钩子 / watch / onMounted 等副作用(尽量少) ## 输出格式建议(给用户看改动时使用) ```diff 改动概要(用中文,简洁有力) 示例: - 删除了 4 处无意义单行函数包装 - 合并了分散在 watch 中的保存逻辑到 handleSubmit - 优化命名:handleData → refreshAndNotify - 减少临时变量 5 个,代码行数减少约 18% - 核心业务逻辑增加 3 处「为什么」注释

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 tvs-clean-code-1776012735 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 tvs-clean-code-1776012735 技能

通过命令行安装

skillhub install tvs-clean-code-1776012735

下载 Zip 包

⬇ 下载 tvs-clean-code v1.0.0

文件大小: 2.27 KB | 发布时间: 2026-4-13 12:24

v1.0.0 最新 2026-4-13 12:24
tv-clean-code 1.0.0 初始版本发布

- 提供代码清洁与整理规范,聚焦降低阅读和维护的认知成本
- 明确四大最高优先级原则,包括减少冗余、集中业务逻辑、优化命名与补充关键注释
- 提出结构优化建议(如函数分拆、魔法值提取、早返回等)
- 包含输出格式建议,便于用户清晰了解代码清理的改动
- 主动引导用户指定待清理的代码范围

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部