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

소개

소프트웨어 개발은 ​​단순히 코드를 작성하는 것이 아닙니다. 다른 개발자가 쉽게 이해할 수 있는 깔끔한 코드를 작성하는 것입니다.

이 기사에서는 훨씬 더 깔끔하고 읽기 쉬운 코드를 작성하는 데 도움이 되는 9가지 팁을 언급했습니다.

1. 설명하는 이름 사용

깨끗한 코드는 이해하기 쉽습니다. 코드를 작성하는 동안 우리는 코드에서 변수, 매개변수 등에 짧은 이름을 사용하지만 변수, 매개변수, 함수 등을 선언할 때는 설명 단어를 사용해야 합니다.

하지 않다

const n = 100;

const it = 200;

하다

const number = 100;

const iterations = 200;

2. 적절한 여백과 들여쓰기 사용

우리 중 많은 사람들이 공백과 들여쓰기를 사용하면 컴파일러 속도에 영향을 미칠 것이라고 생각하지만 코드를 더 쉽게 이해할 수 있도록 공백과 적절한 들여쓰기를 코드에 사용해야 합니다.

하지 않다

function start() {
var name = 'John';
var code = 200;
}

하다

function start() {
  var name = 'John';
  var code = 200;
}

3. 함수의 매개변수 수를 줄이십시오.

이후로 우리는 코드를 깨끗하게 만들려고 노력하고 있습니다. 따라서 no를 줄여서 함수를 작게 만드는 읽기 쉬운 함수를 만들어야 합니다. 그 안에 있는 매개변수에. 2개 또는 3개 이상의 매개변수를 사용해야 하는 경우 세 개의 매개변수 대신 하나의 단일 개체를 매개변수로 보낼 수 있습니다.

하지 않다

function register(name, email, password, phone, address, intresets){

}

하다

function register(info){

}

4. 각 기능은 단일 작업을 수행합니다.

멀티태스킹은 훌륭하지만 깔끔한 코드 작성 측면에서는 그렇지 않습니다. 많은 경우 개발자는 하나 이상의 작업을 수행하는 함수를 생성하지만 다른 사람이 우리 코드를 이해하기 어렵게 만들기 때문에 피해야 합니다. 하나의 작업에 대해 하나의 함수를 생성함으로써 코드를 보다 쉽게 ​​정리할 수 있습니다.

5. 함수의 크기를 줄이십시오.

크기가 크거나 거대한 코드를 포함하는 함수 대신 작은 크기의 함수를 이해하는 것이 더 쉽습니다. 대규모 프로젝트에서 작업하는 경우 함수 대신 클래스를 사용할 수 있습니다.

6. 한 줄에 있는 문자를 줄이십시오.

그래서 우리는 이해하기 쉽고 읽기 쉬운 코드를 작성하고 있습니다. 따라서 코드 라인의 문자를 줄여야 합니다. 코드를 화면에 쉽게 맞출 수 있도록 코드를 보기 위해 가로로 스크롤할 필요가 없습니다.

7. 커밋을 만든 이유를 항상 설명하세요.

github 리포지토리에서 코드를 커밋하는 이유를 항상 정의해야 합니다. 그것은 우리에게 몇 달 전에 우리 코드의 오류나 버그가 무엇인지, 개선을 위해 코드에 어떤 변화가 있었는지에 대한 아이디어를 제공합니다. 이것을 4-10단어 단어로 정의하거나 메시지를 쉽게 정의할 수 있는 단어를 사용할 수도 있습니다.

8. 코드 반복 방지

재사용 가능한 코드 작성에 집중하십시오. 대부분의 초보자는 그렇게하지 않습니다. 코드의 70% 이상을 재사용할 수 있어야 합니다. 이렇게 하면 코드의 크기가 줄어들고 코드를 구성하고 작업하기가 더 쉬워집니다. 작업을 작은 작업으로 나누고 해당 작업에 대한 기능을 만들 수 있습니다.

9. 불필요한 댓글은 쓰지 않는다

우리는 이미 다른 것을 설명하고 지시했기 때문에 코드에 주석이 필요하지 않습니다. 일부 타사 API, 애플리케이션 또는 요청을 사용하는 경우에만 의견을 작성하십시오. 주석을 피하면 코드가 훨씬 깔끔하고 이해하기 쉬워집니다.

전체 기사 읽기
https://techwithpie.blogspot.com/2022/09/tips-for-writing-clean-code.html

감사합니다. 좋은 프로그래밍 경험이 되시기 바랍니다.