ryanmcdermott/clean-code-javascript
将 Robert C. Martin《Clean Code》的编程原则应用于 JavaScript,附好坏代码对比示例。
- Star
- 94,722
- Fork
- 12,572
- 未关闭 Issue
- 124
- 最近提交
- 2年前
这是什么?
本仓库将 Robert C. Martin 的《Clean Code》中的软件工程原则改写为 JavaScript 版本。它定位为提升代码可读性、复用性和可重构性的指南,而非代码格式规范,每个章节都以「坏例子」和「好例子」对照展示。
内容涵盖变量与命名、函数设计(参数数量、单一职责、避免副作用与布尔标记参数)、对象与数据结构、类(组合优于继承、方法链)、SOLID 原则、测试、并发、错误处理、格式化与注释等主题。在需要手动做类型检查时,也建议考虑使用 TypeScript。
作者强调这些原则是指导方针而非严格规则,适合团队在代码评审时作为共同参考。
核心功能
- 01每个原则都提供好坏代码对比
- 02涵盖命名、函数、类与 SOLID 原则
- 03包含测试、并发与错误处理等章节
- 04说明何时应选择组合而非继承
- 05面向 JavaScript 代码评审的实践指南
适用场景
- 帮助新加入的 JavaScript 开发者了解团队代码质量标准
- 评审和重构已有的 JavaScript 项目
- 为代码评审讨论或内部培训准备示例
标签
常见问题
- clean-code-javascript 是什么?
- 将 Robert C. Martin《Clean Code》的编程原则应用于 JavaScript,附好坏代码对比示例。 本仓库将 Robert C. Martin 的《Clean Code》中的软件工程原则改写为 JavaScript 版本。它定位为提升代码可读性、复用性和可重构性的指南,而非代码格式规范,每个章节都以「坏例子」和「好例子」对照展示。
- clean-code-javascript 可以免费使用吗?用的什么许可证?
- clean-code-javascript 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
- clean-code-javascript 还在维护吗?
- 超过半年未提交。clean-code-javascript 最近一次提交是在 2024年7月29日。
- clean-code-javascript 适合用来做什么?
- 帮助新加入的 JavaScript 开发者了解团队代码质量标准 评审和重构已有的 JavaScript 项目 为代码评审讨论或内部培训准备示例
- 在哪里获取 clean-code-javascript?
- 源代码和安装说明在 GitHub 上:https://github.com/ryanmcdermott/clean-code-javascript
概要由 AI 根据项目 README 生成;GitHub 数据每日更新。
相关项目
一个轻量精简的 JavaScript 框架,直接在 HTML 标记中添加响应式交互行为。
3.2万1396HTMLMIT更新于 4天前
一个嵌入网页运行的 JavaScript GUI 智能体,可用自然语言操控页面界面。
3万2879TypeScriptMIT更新于 20小时前
一个 TypeScript 框架,用于构建 AI 智能体和大模型驱动的应用,内置工作流、工具、记忆与评测。
2.9万3021TypeScriptOther更新于 5小时前
开源静态分析工具,用接近源码的模式查找代码缺陷并执行编码规范,支持 30 多种语言。
1.7万1112CLGPL-2.1更新于 15小时前
一个 JavaScript 自然语言处理库,可做词性标注、文本模式匹配,并转换动词时态、数字等内容。
1.2万668JavaScriptMIT更新于 18小时前