编写高质量代码的思考与实践
高质量的代码不仅是能运行的代码,更是易于理解、易于维护的代码。
命名的重要性
好的命名能让代码自文档化:
// 不好的命名
const d = new Date();
const x = getData();
// 好的命名
const currentDate = new Date();
const userProfiles = fetchUserProfiles();
函数设计原则
单一职责
每个函数只做一件事:
// 不好的做法
function processUser(user) {
validateUser(user);
saveToDatabase(user);
sendEmail(user);
}
// 好的做法
function validateAndSaveUser(user) {
validateUser(user);
saveToDatabase(user);
}
function notifyUserAfterRegistration(user) {
sendWelcomeEmail(user);
}
参数数量控制
// 参数过多时使用对象
interface CreateUserParams {
name: string;
email: string;
age: number;
role: string;
}
function createUser(params: CreateUserParams) {
// ...
}
错误处理
async function fetchUserData(userId: string) {
try {
const response = await api.get(`/users/${userId}`);
return response.data;
} catch (error) {
if (error.response?.status === 404) {
throw new UserNotFoundError(userId);
}
logger.error('Failed to fetch user:', error);
throw new ServiceUnavailableError();
}
}
编写高质量代码是一种习惯,需要持续学习和实践。
