형식 맞추기 #4

목차

• 포맷팅이 중요한 이유
• 클린 코드 포맷팅
• Java Class Declarations
• Team Coding Convention

포맷팅이 중요한 이유

가독성에 필수적이다.

// 안좋은 포맷팅..
public void horriblyFormattedMethod() {
System.out.println("First line);
    	System.out.println("Second line);
    System.out.println("Third line);
    for (int i = 0; i < 3; i++) 
    System.out.println("number " + i);
}

// 좋은 포맷팅
public void horriblyFormattedMethod() {
    System.out.println("First line);
    System.out.println("Second line);
    System.out.println("Third line);
    for (int i = 0; i < 3; i++) {
    	System.out.println("number " + i);
    }
}

 

코드를 수월하게 읽어나갈 수 있다.

포맷팅으로 인해 코드를 잘못 해석해 버그를 발생할 위험을 줄인다.

클린 코드 포맷팅

적절한 길이 유지 - 200라인

• "코드 길이를 200줄 정도로 제한하는 것이 반드시 지킬 엄격한 규칙은 아니지만, 일반적으로 큰 파일보다는 작은 파일이 이해하기 쉽다" -> 현업에서의 대부분 코드들도 200라인 정도를 유지한다.
• 코드 길이가 200라인을 넘어간다면, 클래스가 여러 개의 일을 하고 잇을 수 있다. SRP(단일 책임 원칙)에 위배!

밀접한 개념은 서로 가까워 둔다.

• 행 묶음은 완결된 생각 하나를 표한하기 때문에 개념은 빈 행으로 분리한다.
• 변수는 사용되는 위치에서 최대한 가까이 선언한다.

Java Class Declarations

class 내부 코드 순서

1. static 변수 public -> protected -> public -> private 순서
2. instance 변수 public -> protected -> public -> private 순서
3. 생성자
4. 메서드 - public 메서드에서 호출되는 private 메서드는 그 아래에 둔다. 가독성 위주로 그룹핑

Coding Convention

팀의 코딩 스타일에 관한 약속

개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다. 없다면, 함께 만들어 가는 것이 좋다.

 

Googel Java Style Guide

https://google.github.io/styleguide/javaguide.html 

Google Java Style Guide

Naver Hackday Java Convetion

https://naver.github.io/hackday-conventions-java/