JavaScript 代码道德：编写干净、道德的代码

发布日期： 2024-10-26 阅读量： 作者： 网络

javascript 代码道德：编写干净、道德的代码

在当今快节奏的开发世界中，快速交付解决方案至关重要。然而，在代码质量上偷工减料通常会导致错误、安全漏洞和不可维护的代码。代码道德在生成功能性代码和可维护、高效且安全的代码方面发挥着关键作用。让我们通过示例探讨 JavaScript 开发中的关键道德原则以及它们如何提高代码质量。

清晰胜过聪明道德原则：优先考虑代码的可读性和简单性，而不是“聪明”或复杂的解决方案。代码的读取次数多于编写次数。使其易于理解对于长期维护至关重要。

示例：当存在更清晰的替代方案时，避免使用简洁或复杂的结构。

坏例子

![图片描述](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/zkyc8dla0ty0kgpn5vcu.png)

好例子
const doubleArray = arr => arr.map(x => x * 2); // 清晰易懂
在此示例中，按位运算符

避免全球范围污染道德原则：避免通过全局声明变量来污染全局范围，这可能导致名称冲突和意外行为。

坏例子

让计数 = 0； // 在全局范围内声明
函数增量() {
计数++；
}
好例子

(() => {
让计数= 0； // 封装在闭包中
函数增量() {
计数++；
}
})();
通过将代码包装在 IIFE（立即调用函数表达式）中，count 变量的作用域是本地的，避免了与代码其他部分的潜在冲突。

小心处理错误道德原则：优雅地处理错误并提供信息丰富的消息。无声的失败可能会导致不可预测的行为。

坏例子

函数 getUser(id) {
返回 fetch(/user/${id}).then(res => res.json()); // 没有错误处理
}
好例子

异步函数 getUser(id) {
尝试{
const res = wait fetch(/user/${id});
if (!res.ok) {
抛出新错误（无法获取用户：${res.statusText}）；
}
返回等待 res.json();
} catch (错误) {
console.error('获取用户时出错：', error);
返回空；
}
}
通过添加错误处理，您不仅可以防止应用程序无提示地失败，还可以提供有关出错原因的有意义的信息。

模块化您的代码道德原则：将大的函数或文件分解成更小的、可重用的模块。这改善了代码组织、测试和可读性。

坏例子

函数 processOrder(order) {
// 验证订单的代码
// 计算总计的代码
// 处理付款的代码
// 生成收据的代码
}
好例子

`function validateOrder(order) { /* ... / }
functioncalculateTotal(order) { / ... / }
function processPayment( paymentInfo) { / ... / }
functiongenerateReceipt(order) { / ... */ }

函数 processOrder(order) {
if (!validateOrder(order)) return;
const Total =calculateTotal(order);
processPayment(order. paymentInfo);
生成收据（订单）；
}`
这种模块化方法使您的代码更易于理解、测试和维护。每个职能都有单一职责，遵循单一职责原则 (SRP)。

尊重数据隐私道德原则：谨慎处理敏感数据。不要在日志、控制台消息或公共端点中暴露不必要的数据。

坏例子

函数 processUser(用户) {
console.log(处理用户：${JSON.stringify(user)}); // 暴露敏感数据
// ...
}
好例子

函数 processUser(用户) {
console.log(处理用户：${user.id}); // 仅记录必要的详细信息
// ...
}
在这种情况下，不良示例会在控制台中暴露潜在的敏感用户信息。好的示例仅记录必要的内容，遵循数据隐私最佳实践。

遵循 DRY（不要重复自己）原则道德原则：避免代码重复。相反，将重复的逻辑抽象为可重用的函数。

坏例子

`函数 createAdmin(名称, 角色) {
return { 名称, 角色, 权限: ['创建', '读取', '更新', '删除'] };
}

function createEditor(名称, 角色) {
return { 名称, 角色, 权限: ['创建', '读取'] };
}`
好例子

`函数createUser(名称、角色、权限) {
return { 名称、角色、权限 };
}

const admin = createUser('Alice', 'Admin', ['创建', '读取', '更新', '删除']);
const editor = createUser('Bob', 'Editor', ['create', 'read']);`
通过遵循 DRY 原则，您可以消除代码重复，从而减少未来更新中出现不一致或错误的机会。

记录您的代码道德原则：记录您的代码，以确保其他开发人员（或未来的您）清楚您的意图和思维过程。

坏例子

函数calculateAPR(金额, 利率) {
退货金额*比率/100/12； // 没有解释公式代表什么
}
好例子

`/**

计算每月APR
@param {number} amount - 本金金额
@param {number} rates - 年百分比
@return {number} - 每月年利率*/ 函数计算年利率（金额，利率）{ 退货金额*比率/100/12； // 文档中解释的 APR 公式 }` 良好的文档可确保任何阅读代码的人都可以理解其功能，而无需对逻辑进行逆向工程。

编写单元测试道德原则：编写单元测试可确保您的代码按预期工作，并有助于防止随着代码的发展而引入错误。

坏例子
// 没有测试覆盖
好例子
// 使用 Jest 或 Mocha
等测试框架 test('calculateAPR 应返回正确的 APR', () => {
Expect(calculateAPR(1000, 12)).toBe(10);
});
通过编写测试，您可以确保您的代码可靠、可验证并且易于自信地重构。

采用代码风格指南道德原则：在整个团队或项目中遵循一致的编码风格。这可以改善协作并减少误解。

考虑使用 ESLint 或 Prettier 等工具来强制代码的一致性。

ESLint 配置示例

{
"extends": "eslint:推荐",
“env”：{
“浏览器”：正确，
“es6”：正确
},
“规则”：{
"缩进": ["错误", 2],
"quotes": ["错误", "单个"],
“半”：[“错误”，“总是”]
}
}
通过遵循风格指南，您的代码库将保持一致的结构，使其他人更容易贡献和审查代码。

结论
符合道德的 JavaScript 编码实践可确保您的代码不仅实用，而且可维护、安全且面向未来。通过关注清晰度、模块化、错误处理和数据隐私，您可以创建一个尊重其他开发人员和最终用户的代码库。将这些实践纳入您的工作流程将帮助您编写更干净、更可靠的代码并营造更健康的开发环境。

以上就是JavaScript 代码道德：编写干净、道德的代码的详细内容，更多请关注其它相关文章！

# ai # 作用域 # 敏感数据

上一篇: WordPress网站如何选购合适的托管服务？

下一篇: WordPress无法访问？专家指导解决问题！

JavaScript 代码道德：编写干净、道德的代码

随便看看