[Clean Code] Chapter 05

코드의 가독성에 필수적은 포맷팅

 

목차

1. 포맷팅이 중요한 이유

2. 크린코드 포맷팅

3. Java Class Declarations

4. Team Coding Covention

---

1. 포맷팅이 중요한 이유

  * 가독성이 필수적이다.

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

  - 아마추어처럼 보이지 않는다.

  - 코드를 잘못 해석해서 버그를 발생하는 위험을 줄일 수 있다.

 

 

2. 클린코드 포맷팅

  - 적절한 길이 유지 :

        200라인 정도, 200라인 넘어간다면 클래스가 여러개의 일을 하고 있을 가능성이 높다.

  - 밀접한 개념은 서로 가까이에 둔다 :

        행 묶음은 완결된 생각 하나를 표현하기 때문에 개념은 빈 행으로 분리한다.

        변수는 사용되는 위치에서 최대한 가까이 선언한다.

 

 

3. Java Class Declarations

  Class 내부 코드 순서

   1. static 변수 :

       public -> protected -> package -> private 순서

   2. instance 변수 :

       public -> protected -> package -> private 순서

   3. 생성자

   4. 메서드 :

       public 메서드에서 호출되는 private 메서드는 그 아래에 둔다. 가독성 위주로 그룹핑

 

 

4. Team Coding Convention

  개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다. 없다면 같이 만들어가자!

 

참고 컨벤션

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

캠퍼스 핵데이 Java 코딩 컨벤션

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

Google Java Style Guide