프로그래머는 형식을 깔끔하게 맞춰 코드를 작성해야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고, 그 규칙을 따라야 한다.
팀으로 일한다면 팀이 합의하여 규칙을 정하고 모두가 그 규칙을 따라야 한다.
가능하다면 규칙을 자동으로 적용하는 도구를 사용하면 더욱 편해진다.
형식을 맞추는 목적
코드 형식은 의사소통의 일환이다.
또한 의사소통은 전문 개발자의 1차적인 의무이다.
오늘 구현한 기능이 다음 버전에서 바뀔 확률은 매우 높다. 하지만 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 줄 수 있다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
그러므로 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
적절한 행 길이 유지
소스코드는 얼마나 길어야 적당할까?
분석 결과 500줄을 넘지 않고도 200줄 정도인 파일로도 커다란 시스템을 구축하는데 무난하다고 한다.
반드시 지켜줘야 하는 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋을 것 같다.
일반적으로도 큰 파일보다 작은 파일이 이해하기 쉬워지기 때문이다.
신문기사처럼 작성
보기 좋게 작성된 신문기사는 독자들이 보통 위에서 아래로 기사를 읽어 내려가는게 통상적이다.
최상단에 기사를 몇 마디로 요약하는 표제가 나오고, 독자들은 표제를 보고 기사를 읽을지 말지 결정한다.
첫 문단은 전체 기사 내용을 요약하고 세세한 내용들은 숨기고 커다란 그림만을 보여준다.
그리곤 쭉 읽어 내려가면 세세한 내용들이 나온다.
소스 파일도 신문 기사처럼 작성하는게 좋다. 이름이 간단함과 동시에 설명이 가능하게끔 짓자.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하고 아래로 내려갈수록 의도를 세세하게 묘사하자.
그리고 마지막에 가장 저차원 함수와 세부 내역이 나오도록 한다.
개념은 빈 행으로 구분하라
모든 코드는 특별한 경우를 제외하고는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각을 표현한다.
생각과 생각 사이에는 빈 행을 넣어 분리하는 것이 합당하다.
아래 코드를 통해 빈 행으로 구분한 경우와 아닌 경우의 차이점을 비교해보자.
구분한 경우
class Test {
var size: Int = 0
private var head: Node ?= null
private var tail: Node ?= null
fun addFirst(item : Int){
val newNode = Node().apply {
this.item = item
this.next = head
}
head = newNode
if (head?.next == null){
tail = head
}
size++
}
}
안 한 경우
class Test {
var size: Int = 0
private var head: Node ?= null
private var tail: Node ?= null
fun addFirst(item : Int){
val newNode = Node().apply {
this.item = item
this.next = head
}
head = newNode
if (head?.next == null){
tail = head
}
size++
}
}
빈 행이 있고 없고에 따라 가독성에 큰 차이를 준다.
세로 밀집도
세로 밀집도는 곧 연관성을 의미한다.
즉, 서로 연관 있는 코드들은 세로로 가까이 붙여놓는 게 좋다.
아래 두 코드를 비교해보자.
public class ReporterConfig{
/**
* 리포터 리스너의 클래스 이름
*/
private Strign m_className;
/**
* 리포터 리스너의 속성
*/
private List<Property> m_properties = new ArrayList<Property>();
public void addProperty(Property property){
m_properties.add(property);
}
}
public class ReporterConfig{
private Strign m_className;
private List<Property> m_properties = new ArrayList<Property>();
public void addProperty(Property property){
m_properties.add(property);
}
}
첫 번째 코드는 의미 없는 주석으로 두 인스턴스 변수를 떨어뜨려 놓았고, 두 번째 코드는 밀접한 단위별로 구분을 해두었다.
누가 봐도 아래 코드가 더 눈에 잘 들어온다.
'클린 코드' 카테고리의 다른 글
[클린 코드] 객체와 자료구조(1) (0) | 2022.01.19 |
---|---|
[클린 코드] 형식 맞추기(2) (0) | 2022.01.17 |
[클린 코드] 주석(2) (0) | 2022.01.05 |
[클린 코드] 주석(1) (0) | 2022.01.04 |
[클린 코드] 함수(3) (0) | 2021.12.29 |