JavaScript 코드 윤리: 깨끗하고 윤리적인 코드 작성

오늘날의 빠르게 변화하는 개발 세계에서는 솔루션을 빠르게 제공하는 것이 필수적입니다. 그러나 코드 품질을 무시하면 버그, 보안 취약성 및 유지 관리할 수 없는 코드가 발생하는 경우가 많습니다. 코드 윤리는 기능적일 뿐만 아니라 유지 관리 가능하고 효율적이며 안전한 코드를 생성하는 데 중추적인 역할을 합니다. JavaScript 개발의 주요 윤리 원칙과 예제를 통해 코드 품질을 향상시킬 수 있는 방법을 살펴보겠습니다.

1. 영리함보다 명확함 윤리 원칙: "영리"하거나 복잡한 솔루션보다 코드 가독성과 단순성을 우선시합니다. 코드는 작성된 것보다 읽는 것이 더 자주 발생합니다. 장기적인 유지 관리를 위해서는 이해하기 쉽게 만드는 것이 중요합니다.

예: 더 명확한 대안이 있는 경우 간결하거나 복잡한 구문을 사용하지 마세요.

나쁜 예


좋은 예
const doubleArray = arr => arr.map(x => x * 2); // 명확하고 이해하기 쉽다
이 예에서는 비트 연산자 << 작동하지만 간단한 곱셈을 사용하는 것보다 읽기가 어렵습니다. 명확성을 선택하면 팀이나 미래의 자신이 코드를 쉽게 이해하고 유지할 수 있습니다.

1. 글로벌 범위 오염 방지 윤리 원칙: 전역적으로 변수를 선언하여 전역 범위를 오염시키지 마십시오. 이로 인해 이름 충돌 및 예상치 못한 동작이 발생할 수 있습니다.

나쁜 예

카운트 = 0으로 놔두세요; // 전역 범위에서 선언
함수 증가() {
카운트 ;
}
좋은 예

(() => {
개수 = 0으로 둡니다. // 클로저로 캡슐화
함수 증가() {
카운트 ;
}
})();
코드를 IIFE(즉시 호출 함수 표현식)로 래핑하면 count 변수의 범위가 로컬로 지정되어 코드의 다른 부분과의 잠재적인 충돌을 방지할 수 있습니다.

1. 오류 처리에 주의 윤리 원칙: 오류를 적절하게 처리하고 유익한 메시지를 제공합니다. 조용한 실패는 예측할 수 없는 동작으로 이어질 수 있습니다.

나쁜 예

함수 getUser(id) {
return fetch(/user/${id}).then(res => res.json()); // 오류 처리 없음
}
좋은 예

비동기 함수 getUser(id) {
시도해보세요 {
const res = 가져오기를 기다립니다(/user/${id});
if (!res.ok) {
새로운 오류 발생(사용자를 가져오지 못했습니다: ${res.statusText});
}
반환을 기다리고 res.json();
} 잡기(오류) {
console.error('사용자를 가져오는 중 오류 발생:', error);
null을 반환합니다.
}
}
오류 처리를 추가하면 앱이 자동으로 실패하는 것을 방지할 수 있을 뿐만 아니라 무엇이 잘못되었는지에 대한 의미 있는 정보도 제공할 수 있습니다.

1. 코드를 모듈화하세요 윤리 원칙: 대규모 기능이나 파일을 더 작고 재사용 가능한 모듈로 나눕니다. 이를 통해 코드 구성, 테스트 및 가독성이 향상됩니다.

나쁜 예

함수 processOrder(order) {
// 주문 확인 코드
// 합계 계산 코드
//결제 처리 코드
// 영수증 생성 코드
}
좋은 예

`function verifyOrder(order) { /* ... / }
functioncalculateTotal(order) { / ... / }
함수 processPayment(결제 정보) { / ... / }
function generateReceipt(order) { / ... */ }

함수 processOrder(order) {
if (!validateOrder(order)) return;
const total = 계산Total(주문);
processPayment(order.paymentInfo);
generateReceipt(주문);
}`
이 모듈식 접근 방식을 사용하면 코드를 더 쉽게 이해하고, 테스트하고, 유지 관리할 수 있습니다. 각 기능에는 단일 책임 원칙(SRP)을 준수하는 단일 책임이 있습니다.

1. 데이터 개인정보 보호를 존중합니다. 윤리 원칙: 민감한 데이터를 주의해서 다루십시오. 로그, 콘솔 메시지, 공개 엔드포인트에 불필요한 데이터를 노출하지 마세요.

나쁜 예

함수 processUser(사용자) {
console.log(처리 중인 사용자: ${JSON.stringify(user)}); // 민감한 데이터 노출
// ...
}
좋은 예

함수 processUser(사용자) {
console.log(처리 중인 사용자: ${user.id}); // 필요한 세부정보만 로깅
// ...
}
이 경우 나쁜 예는 잠재적으로 민감한 사용자 정보를 콘솔에 노출합니다. 좋은 예는 데이터 개인 정보 보호 모범 사례에 따라 필요한 것만 기록합니다.

1. DRY(반복하지 마세요) 원칙을 따르세요. 윤리 원칙: 코드 중복을 피하십시오. 대신 반복되는 논리를 재사용 가능한 함수로 추상화하세요.

나쁜 예

`function createAdmin(이름, 역할) {
return { 이름, 역할, 권한: ['만들기', '읽기', '업데이트', '삭제'] };
}

function createEditor(이름, 역할) {
return { 이름, 역할, 권한: ['create', 'read'] };
}`
좋은 예

`function createUser(이름, 역할, 권한) {
return { 이름, 역할, 권한 };
}

const admin = createUser('Alice', 'Admin', ['create', 'read', 'update', 'delete']);
const editor = createUser('Bob', 'Editor', ['create', 'read']);`
DRY 원칙을 따르면 코드 중복이 제거되어 향후 업데이트에서 불일치나 오류가 발생할 가능성이 줄어듭니다.

1. 코드를 문서화하세요 윤리 원칙: 다른 개발자(또는 미래의 자신)가 자신의 의도와 사고 과정을 명확하게 이해할 수 있도록 코드를 문서화하세요.

나쁜 예

calculateAPR(금액, 요율) 기능 {
반품 금액 * 요율 / 100 / 12; // 수식이 무엇을 나타내는지에 대한 설명이 없습니다
}
좋은 예

`/**

• 월간 연이율 계산
• @param {number} 금액 - 원금
• @param {number} rate - 연간 비율
• @return {number} - 월간 APR */ 함수 계산APR(금액, 요율) { 반품 금액 * 요율 / 100 / 12; // 문서에 설명된 APR 공식 }` 좋은 문서화는 코드를 읽는 사람이 로직을 리버스 엔지니어링하지 않고도 코드의 기능을 이해할 수 있도록 보장합니다.

1. 단위 테스트 작성 윤리 원칙: 단위 테스트를 작성하면 코드가 예상대로 작동하고 코드가 발전함에 따라 버그가 발생하는 것을 방지하는 데 도움이 됩니다.

나쁜 예
// 테스트 적용 범위 없음
좋은 예
// Jest 또는 Mocha와 같은 테스트 프레임워크 사용
test('calculateAPR은 올바른 APR을 반환해야 합니다.', () => {
예상(calculateAPR(1000, 12)).toBe(10);
});
테스트를 작성하면 코드가 안정적이고 검증 가능하며 자신있게 리팩토링하기 쉬운지 확인할 수 있습니다.

1. 코드 스타일 가이드 채택 윤리 원칙: 팀이나 프로젝트 전반에 걸쳐 일관된 코딩 스타일을 따르십시오. 이를 통해 협업이 향상되고 오해가 줄어듭니다.

코드의 일관성을 강화하려면 ESLint 또는 Prettier와 같은 도구를 사용하는 것이 좋습니다.

ESLint 구성 예시

{
"extends": "eslint:권장",
"환경": {
"브라우저": 사실,
"es6": 참
},
"규칙": {
"indent": ["error", 2],
"따옴표": ["오류", "단일"],
"semi": ["오류", "항상"]
}
}
스타일 가이드를 준수하면 코드베이스가 일관된 구조를 유지하므로 다른 사람이 코드를 더 쉽게 작성하고 검토할 수 있습니다.

결론
윤리적인 JavaScript 코딩 관행은 코드가 기능적일 뿐만 아니라 유지 관리가 가능하고 안전하며 미래에도 사용할 수 있도록 보장합니다. 명확성, 모듈성, 오류 처리 및 데이터 개인 정보 보호에 중점을 두어 동료 개발자와 최종 사용자를 모두 존중하는 코드베이스를 만듭니다. 이러한 방법을 워크플로에 통합하면 더욱 깔끔하고 안정적인 코드를 작성하고 보다 건강한 개발 환경을 조성하는 데 도움이 됩니다.

위 내용은 JavaScript 코드 윤리: 깨끗하고 윤리적인 코드 작성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!