프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 규칙을 정하고 착실히 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

코드의 형식은 의사소통의 일환이다. 너무나도 중요함으로 융통성 없이 맹목적으로 따르기만 해도 안된다. 오랜 시간이 지나서 원래 코드의 흔적을 더이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
원래 코드가 사라지더라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

소스코드는 얼마나 길어야 적당할까? 저자가 예로 든 JAVA 코드에서의 길이는 대부분 500줄을 넘지 않고, 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 반드시 지켜야 할 규칙은 아니지만 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

(분야에 따라 적절한 라인은 정해져있고, 여기서 주시하고 넘어가야 할 점은 큰 파일보다 작은 파일이 이해하기 쉽다는것. 결국 목적에 맞게 쪼개고 쪼개야한다.)

신문기사처럼 작성하라

소스파일도 좋은 신문기사처럼 작성하면 좋다.

• 이름은 간단하면서도 설명이 가능하게. 이름만 보고도 올바른 모듈을 살펴보고 있는지 알 수 있도록 짓는다.
• 소스파일의 첫부분은 고차원적인 개념과 알고리즘을 설명한다. (??)
• 소스코드 아래로 내려갈수록 의도를 세세하게 묘사한다.
• 가장 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

(첫부분에 고차원적인 개념과 알고리즘을 설명한다는게... 무슨말이지...?)

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적인 단서. 코드를 읽어내려가다보면 빈 행 바로 다음줄에 눈길이 멈춘다. 빈 행이 없으면 눈의 초점을 흐리게하고 전체가 한 덩어리로 보인다. 가독성 확보를 위해 빈 행은 반드시 필요하다.

import SomeModul

class AAA {
	var someString: String?
    
	init() { ... }
    
    func calculate() -> Int { ... }
}

(빈 행이 새로운 개념을 알린다. Swift 에서는 빈 행과 함께 extension 으로 분할하거나, 적절한 MARK를 활용하는것으로...)

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.서로 연관되어 있는 변수는 빈 개행없이 하나로 묶는게 좋다. 코드가 한눈에 들어올 수 있도록.

before

public class ReporterConfig { 
	/**
	* 리포터 리스너의 클래스 이름 
    */
	private String m_className; 

	/**
    * 리포터 리스너의 속성 
    */
	private List‹Property> m_properties = new ArrayList<Property>();
}

after

public class ReporterConfig { 
	private String m_className; 
    private List‹Property> m_properties = new ArrayList<Property>();
}

(쓸모없는 주석이나 개행으로 보기 힘들게 하는것보다 연관성이 있는 변수는 밀집시켜서 한눈에 파악하기 쉽게 하는게 포인트.)

수직거리

소스코드를 이해하기 위해 아주아주 힘들었던 경험리스트

• 함수의 연관 관계와 동작을 이해하기위해 코드를 점프점프.
• 한 파일 안에서 위아래로 왔다갔다 찾아보기
• 상속관계를 줄줄이 거슬러 올라가기

이게 서로 밀접한 개념을 세로로 가까이 둬야 하는 이유라고 저자는 설명한다. 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스파일과 클래스를 여기저기 뒤지게 된다.

변수선언

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

• 지역변수는 각 함수의 맨 처음에 선언한다.
• 루프를 제어하는 변수는 루프문 내부에 선언한다.
• 아주 긴 함수라면 블록의 상단이나 루프 직전에 변수를 선언하기도 한다
• (이 책의 요점대로라면 이 긴 함수 자체가 함정이다. 목적에 맞게 분할해야한다.)

인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다. 변수간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문이다. (...???)

(저자는 인스턴스 변수의 선언에 대해 클래스 맨 마지막에 선언하는 케이스(가위규칙?)도 있다고 하는데... 난 본적없다.)

종속함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.

개념적 유사성

개념적인 친화도가 높을수록 코드를 가까이 배치한다.

개념적 친화도가 높은 요인

• 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성.
• 변수와 그 변수를 사용하는 함수
• 비슷한 동일 동작을 수행하는 함수

예의 함수들은 명명법이 똑같고 기본 기능이 유사하다. 이런 유사성과 종속성을 가지고있다면 가까이 배치하는게 좋다.

Class Assets {
	func assetTrue(message: String?, condition: Bool) { ... }
    
    func assetTrue(condition: Bool) {
    	assetTrue(message: nil, condition: condition)
    }
    
    func assetFalse(message: String?, condition: Bool) {
    	assetTrue(message: message, condition: !condition)
    }
    
    func assetFalse(condition: Bool) {
    	assetFalse(nil, condition)
	}
}

가로 형식 맞추기

한 행의 가로는 얼마가 적절한가? 예시로 나온 JAVA 에서는 45자 근처 (..??). 프로그래머는 명백하게 짧은 행을 선호한다고 나와있다. 요점은 한 화면에서 가로로 스크롤 할 필요가 없도록 작성하는것. 요즘은 모니터가 커서 200자도 한 화면에 들어가지만, 가급적이면 120자 정도로 행 길이를 제한하도록 한다.

(내 Xcode 개인 설정은 120자...!)

가로 공백과 밀집도

가로로 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

func measureLine(line: String) {
	lineCount++
    let lineSize = line.length()
    lineWidthHistogram.addLine(lineSize, lineCount)
    recordWidesLine(lineSize)
    ...
}

func root(a: Int, b: Int, c: Int) {
	let determinant = determinant(a, b, c)
	return (-b - Math.sqrt(determinant) / (2*a))
}

func determinant(a: Double, b: Double, c: Double) -> Double {
	return b*b - 4*a*c
}

• 할상 연산자를 강조하기 위해 앞뒤에 공백을 적용한다.
• 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다.
• 함수 안의 인수는 공백으로 분리한다.
• 승수 사이엔 공백이 없다. (??)

(우리는 사이에도 공백을 넣고있습니다. 우선순위를 위해서는 () 를 넣는걸로...)*

가로 정렬

let socket			= Socket()
let inpuitStreem	= InputStreem()

이런 정렬은 별로 유용하지 않다. 코드가 엉뚱한 부분을 강조해서 진짜 의도가 가려지기 때문. 정렬이 필요할 정도로 목록이 길다면 목록의 길이가 문제이지 정렬문제가 아니다. (오...)

들여쓰기

• 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.

• 메소드 코드는 메소드 선언보다 한 수준 들여쓴다.

• 블록코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

  들여쓰기한 파일은 구조가 한눈에 들어온다.

  (요즘 IDE 만만세.)

들여쓰기 무시하기

간단한 if, while 등등은 들여쓰기를 무시하고 싶은 유혹이 생긴다. 간단하더라도 들여쓰기를 통해 가독성을 확보해야한다.

(...음.... 으으음....? 단순한 guard 문이나 protocol 의 확장형 같은 건 어찌해야하나...? )

/// swift 에서 옵셔널을 해제하는 방법
guard let a = a else { return }

/// swift 에서 프로토콜 함수를 옵셔널로 쓰는 방법...
protocol A {
	func aaa()
}

extension A {
	func aaa() {}
}

팀 규칙

팀 규칙이라는 제목은 말 장난이다. (??) 팀은 한가지 규칙에 합의해야 하며, 팀원은 그 규칙을 따라야한다. 그래야 일관적인 스타일을 확보할 수 있다. 개개인이 따로국밥처럼 (?! 초월번역...?) 맘대로 짜대는 코드는 피해야한다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 항상 기억하고, 스타일을 일관적이고 매끄롭게 유지할 수 있도록 노력해야한다.

마무리

(거의 아무 의미없이 따라하던 형식들...! 습관적으로 쓰고있었지만 하나하나 따져보니 필요한게 맞다. 결국 일관적인 스타일만이 다른 사람이 코드를 살펴볼때 혼란이 없도록 하는 지표가 된다.)