clean-codejs-naming

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Clean Code JavaScript – Naming Patterns

Clean Code JavaScript – 命名模式

Table of Contents

目录

  • Principles
  • Variables
  • Functions
  • Booleans
  • Bad vs Good Examples
  • 原则
  • 变量
  • 函数
  • 布尔值
  • 反面示例 vs 正面示例

Principles

原则

  • Names should reveal intent
  • Avoid abbreviations and mental mapping
  • Use domain language consistently
  • 命名应清晰表达意图
  • 避免缩写与思维映射
  • 始终使用领域语言

Variables

变量

js
// ❌ Bad
const d = 86400000;

// ✅ Good
const MILLISECONDS_PER_DAY = 86400000;
js
// ❌ 反面示例
const d = 86400000;

// ✅ 正面示例
const MILLISECONDS_PER_DAY = 86400000;

Functions

函数

js
// ❌ Bad
function getUser(u) {}

// ✅ Good
function fetchUserById(userId) {}
js
// ❌ 反面示例
function getUser(u) {}

// ✅ 正面示例
function fetchUserById(userId) {}

Booleans

布尔值

js
// ❌ Bad
if (!user.isNotActive) {}

// ✅ Good
if (user.isActive) {}
js
// ❌ 反面示例
if (!user.isNotActive) {}

// ✅ 正面示例
if (user.isActive) {}

Bad vs Good Examples

反面示例 vs 正面示例

js
// ❌ Bad
const data = getData();

// ✅ Good
const usersResponse = fetchUsers();
js
// ❌ 反面示例
const data = getData();

// ✅ 正面示例
const usersResponse = fetchUsers();