>웹 프론트엔드 >JS 튜토리얼 >깔끔한 코드를 작성하는 방법

깔끔한 코드를 작성하는 방법

Mary-Kate Olsen
Mary-Kate Olsen원래의
2024-10-23 16:39:02434검색

클린 코드를 작성하는 이유는 무엇입니까? ⛩️

How to write clean code
지저분한 방에서 무언가를 찾으려고 한다고 상상해 보십시오. 검색하는 데 시간을 낭비하게 될 것입니다. 그렇죠?

복잡한 코드도 마찬가지입니다! 문제를 찾거나 무슨 일이 일어나고 있는지 이해하는 것이 더 어렵습니다. 깨끗한 코드를 사용하면 이러한 혼란을 피할 수 있습니다.

그거 알아요?.. 깔끔한 코드를 작성하면 다른 개발자의 귀중한 시간도 절약할 수 있습니다. 저를 믿으세요... 당신이 세상을 구하고 있습니다! ?


깔끔한 코드 작성을 위한 7가지 팁?

How to write clean code

1. 의미 있는 이름을 사용하세요

변수나 함수를 만들 때 무엇을 하는지 알려주는 이름을 지정하세요.

컴퓨터의 폴더 이름을 지정하는 것과 같다고 생각하세요. b라고 부르는 대신 numberOfUsers라고 부릅니다. 이렇게 하면 b가 무엇인지 설명하기 위해 추가 설명이 필요하지 않습니다.

:

let numberOfUsers = 5; // Clear and easy to understand

2. 단일 책임 원칙(SRP)을 따르세요.

함수는 한 가지 일을 잘 수행해야 합니다.

이렇게 하면 이해하기 쉽고 필요한 경우 수정할 수 있습니다. 글쓰기를 위한 연필과 자르기 위한 가위처럼 하나의 작업에 하나의 도구를 사용하는 것과 같습니다.

How to write clean code

:

function addNumbers(a, b) {
    return a + b;
}

이 기능은 두 개의 숫자만 추가합니다. 다른 일은 하지 않습니다.

3. 불필요한 댓글은 피하세요

어디에나 주석을 추가하는 대신 좋은 이름을 사용하여 자체 설명이 가능한 코드를 만드세요.

댓글은 까다롭거나 특별한 메모가 필요한 경우에만 사용하세요. 댓글이 너무 많으면 사람들에게 혼란을 줄 수 있습니다. ??

:

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. 코드를 읽기 쉽게 만드세요

공백, 들여쓰기줄 바꿈을 사용하여 코드를 깔끔하게 유지하세요.

문단을 작성하는 것과 마찬가지로 코드를 작은 조각으로 나누어 한 줄에 모두 작성하지 않도록 해야 합니다.

:

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. 단위 테스트 작성

단위 테스트는 코드를 점검하는 것입니다.

모든 것이 제대로 작동하는지 확인합니다. 코드를 변경할 때 문제가 발생하면 이 테스트를 통해 알려줍니다.

:

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. 의존성에 주의하세요

소프트웨어를 구축할 때 서로 너무 많이 의존하지 않도록 항목을 분리하도록 노력하세요.

예를 들어 식기 세척기는 특정 주방뿐만 아니라 모든 주방에 있을 수 있습니다. 그렇게 하면 관리가 더 쉽습니다.

How to write clean code

7. 프로젝트 정리

책상을 깨끗하게 유지하는 것처럼 파일과 폴더를 깔끔하게 정리하세요. 이렇게 하면 프로젝트 규모가 커질 때 원하는 항목을 더 쉽게 찾을 수 있습니다.

How to write clean code

:

  • 프로젝트에서 구성요소, 서비스, 유틸리티와 같은 폴더를 사용하세요.
  • 유사한 파일을 함께 보관하면 어디서 찾을 수 있는지 알 수 있습니다.

✅ 추천

이 인쇄 가능한 백엔드 개발자 개념 템플릿을 사용하여 진행 상황을 추적하세요! ?

초보 개발자는 올바른 기술 스택을 선택하는 데 어려움을 겪는 경우가 많으며 이로 인해 시간이 낭비되고 동기가 상실됩니다.

그래서 저는 진행 상황을 추적하고 목표를 쉽게 달성할 수 있도록 Notion에서 따라하기 매우 쉬운 아름다운 디자인을 만들었습니다!

How to write clean code

이 로드맵:

  • ?️ 혼란을 피하기 위해 명확한 경로를 제공합니다.
  • ? 시작과 끝을 대략적으로 설명하여 동기를 유지하는 데 도움이 됩니다.
  • ? 학교 강의 계획서와 유사한 구조화된 계획을 따릅니다.
  • ? 도구 및 언어에 대한 주간 목표에 따라 학습을 구성합니다.
  • ⏳ 필요한 모든 것을 포함하여 6개월 안에 완료를 보장합니다.
  • ? 쉽게 탐색할 수 있는 아름다운 디자인이 특징입니다.

How to write clean code


결론 ?

깨끗한 코드를 작성하는 것은 집을 위한 튼튼한 기반을 구축하는 것과 같습니다. 모든 것을 순서대로 유지하므로 큰 어려움 없이 쉽게 새로운 항목을 추가하거나 문제를 수정할 수 있습니다.

다음 7가지 팁을 따라 코드를 간단하고 읽기 쉽고 작업하기 쉽게 만드세요!

자세히 보기: 6개월 안에 백엔드 개발자가 되기 위한 기술(로드맵)

위 내용은 깔끔한 코드를 작성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.