Development tips

좋은 코드를 위한 코드 스타일의 중요성

0

프로그래밍에서 코드 스타일은 우리가 쓰는 글의 맞춤법과 같습니다. 깔끔하고 일관된 코드 스타일은 다른 개발자들에게 좋은 첫인상을 줄 수 있고, 협업 시 중요한 역할을 합니다. 이제 코드 스타일이 왜 중요한지, 그리고 어떻게 적용할 수 있는지 알아보겠습니다.

unsplash

코드 스타일의 중요성

코드를 처음 보는 사람에게 좋은 인상을 남기고 싶으신가요? 그렇다면 코드 스타일을 신경 써야 합니다. 첫인상처럼 코드 스타일은 다른 개발자들이 여러분의 코드를 평가하는 첫 번째 기준이 됩니다. 일관된 스타일은 코드를 읽는 사람에게 전문적이고 신뢰감 있는 이미지를 제공합니다.

코드 스타일 가이드

포맷팅: 인덴트

많은 프로그래밍 언어에서 인덴트의 칸수는 문법에 영향을 주지 않습니다. 하지만 일관되지 않은 인덴트는 코드를 읽기 어렵게 만듭니다.

public class Main {
  public static void main(String[] args) {
    System.out.println("Hello World");
  }
}
public class Main {
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

위 두 코드는 각각 2칸과 4칸 인덴트를 사용했지만, 일관성을 유지하고 있습니다. 반면에 아래 코드처럼 인덴트가 일정하지 않으면 가독성이 떨어집니다.

public class Main {
    public static void main(String[] args) {
      System.out.println("Hello World");
    }
}

네이밍: 언더스코어 사용하지 않기

Google Java 스타일 가이드에서는 언더스코어를 사용하지 않도록 권장합니다. 대신 카멜 케이스(Camel Case)나 파스칼 케이스(Pascal Case)를 사용합니다.

public class CoinManager {
  private int coinNum = 0;

  public int getCoin() {
    return coinNum;
  }

  public void changeCoin(int delta) {
    coinNum += delta;
    if (coinNum < 0) {
      coinNum = 0;
    }
  }
}

이렇게 작성된 코드는 Java의 전형적인 스타일을 따르며, 가독성을 높입니다.

각 언어의 스타일 가이드

구글 코드 스타일 가이드

Google은 여러 프로그래밍 언어에 대한 스타일 가이드를 제공하고 있습니다. 이 가이드를 따르면 더 깔끔하고 일관된 코드를 작성할 수 있습니다.

코드 스타일에 신경 써야 하는 이유

나를 알리는 코드

포트폴리오를 준비할 때 코드 스타일은 매우 중요합니다. 깔끔하고 일관된 코드 스타일은 다른 전문가들에게 좋은 인상을 남기며, 여러분의 능력을 효과적으로 전달할 수 있습니다.

팀의 능률을 올리는 코드

팀 프로젝트에서 일관된 코드 스타일을 유지하면 유지보수성과 확장성이 좋아집니다. 또한, 코드 리뷰가 용이해지며, 팀 내 지식 공유도 원활해집니다. 통일된 코드 스타일은 팀의 성공적인 협업을 위한 첫걸음입니다.

IDE에 코드 스타일 적용하기

Intellij IDEA에서 Google Java Style Guide 적용

  • Intellij IDEA에서 File > Settings를 클릭합니다.
  • Plugins에서 google-java-format을 검색하여 설치합니다.
  • Settings에서 google-java-format Settings 항목을 체크합니다.
  • Tools > Actions on Save에서 Reformat code를 활성화합니다.

Visual Studio Code에서 Google Java Style 적용

  • Extensions에서 Google Java Format for VS Code를 검색하여 설치합니다.
  • Settings에서 default formatter를 설정합니다.
  • format on save를 활성화합니다.

가독성을 높이는 코드 작성법

  • 변수와 함수의 이름은 역할을 명확하게 반영해야 합니다. 약어 사용은 지양하고, 의미 있는 이름을 사용하세요.
  • 함수와 클래스는 각각의 역할이 명확해야 하며, 너무 길거나 복잡하지 않게 작성합니다.
  • 주석은 최소한으로 사용하며, 필요한 정보만 명확하게 전달합니다.

마치며

코드 스타일은 코드를 읽는 사람에게 좋은 첫인상을 남기는 중요한 요소입니다. 조금만 신경 쓰면 누구나 깔끔하고 일관된 코드를 쓸 수 있습니다. 여러분의 코드가 좋은 첫인상을 남길 수 있도록, 코드 스타일을 꼭 지켜보세요!

답글 남기기