-
♻️[클린코드] #4 형식 맞추기Study/클린코드 2022. 5. 30. 21:37
코드의 가독성에 필수적인 포맷팅
♻️ 포맷팅이 중요한 이유
- 가독성에 필수적이다
코드를 수월하게 읽어나갈 수 있고, 아마추어처럼 보이지 않는다.
포맷팅이 되어있지 않아 코드를 잘못 해석해 버그를 발생할 수도 있는데 포맷팅을 통해 가독성을 높혀 위험을 줄인다.
ex) 줄바꿈 간격
♻️ 클린코드 포맷팅
- 적절한 길이 유지
엄격한 규칙은 아니지만, 일반적으로 200줄 정도로 제한한다. (그래도 최대 500줄)
코드가 200줄을 넘어간다면, 클래스가 여러 개의 일을 하고 있을 수 있다. -> SRP에 위배된다.
- 밀접한 개념은 서로 가까이
다른 개념들끼리 빈 행으로 분리한다.
변수는 사용되는 위치에서 최대한 가까이 선언한다.
♻️ Java Class Declarations
- Java Class Declarations
자바 클래스를 어떻게 선언해야하는지에 대한 포맷팅룰.
- Class 내부 코드 순서
변수는 접근지정자에 따라, 메서드는 가독성에 따라 순서를 정한다.
1. static 변수 (가장 상단에 선언) : public -> protected -> package -> private 순서
2. instance 변수 : public -> protected -> package -> private
3. 생성자
4. 메서드 : 가독성 위주로 그룹핑. 호출되는 함수는 호출하는 함수의 아래에 선언
♻️ Team Coding Convention
- Coding Convention
코딩 스타일에 관한 약속
- Team Coding Convention
팀의 코딩 스타일에 관한 약속
개발 언어의 컨벤션이 우선이지만, 애매한 부분은 팀 컨벤션을 따른다.
ex) 변수명, 함수 네이밍, 선언순서, 파일명 등
-> 보통 언어마다 검색해보면 현업에서 많이 따르는 컨벤션들이 있다.
'Study > 클린코드' 카테고리의 다른 글
♻️[클린코드] #6 오류 처리 (0) 2022.06.30 ♻️[클린코드] #5 객체와 자료구조 (0) 2022.06.30 ♻️[클린코드] #3 주석 (0) 2022.05.23 ♻️[클린코드] #2 함수 (0) 2022.05.16 ♻️[클린코드] #1 깨끗한 코드와 의미 있는 이름 (0) 2022.05.08