티스토리 뷰

공부

[Clean Code] 5 : 형식 맞추기

Zedd0202 2018. 3. 16. 22:41
반응형

안녕하세요 :) Zedd입니다.

오늘은..드디어...금요일...마음껏...글을 쓸 수 있는 날입니다. 

한창 클린코드 쓰다가 잠깐 멈췄는데..! 이어서 하겠습니다 :)

클린코드 읽을 때마다 아..이거 진짜..중요하지..레알루다가 중요하다 이거..그러는데 매 챕터가 그럽니다.......

이번 챕터 형식맞추기도 아 이거 진짜..중요하지...라는 생각을 했어요. 이번챕터는 SwiftLint같은 느낌? 



형식 맞추기



프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 

코드 형식을 맞추기 위한 간단한 규칙을 정하고, 그 규칙을 착실히 따라야한다. 

팀으로 일한다면, 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야한다.

필요하면 규칙을 자동으로 적용하는 도구를 활용한다.(SwiftLint가 그 예겠죠?)


형식을 맞추는 목적

- 코드형식은 중요하다! 너무 중요하니까 무시ㄴㄴ

- 코드형식은 의사소통의 일환

- 단순히 '돌아가는 코드'가 전문 개발자의 일차적인 의무라고 생각한다면 꼭 이 글을 읽고 맘이 바뀌시길



적절한 행 길이를 유지하라.

- 소스코드는 얼마나 길어야 할까? -> 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다(당연..)

- 신문 기사 처럼 작성하라. 

여러분 아주 좋은 기사를 떠올려 보세요. 독자는 위에서 아래로 기사를 읽을 것 입니다. 

기사를 요약하는 표제 -> 첫문단은 전체 기사 내용을 요약 -> 쭉 읽어가면서 세세한 사랑이 조금씩 드러남

소스파일도 바로 이렇게 작성해야함.


이름은 간단하면서도 설명이 가능하게 지으며, 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 지어야 함.


- 개념은 빈 행으로 분리하라.

일련의 행 묶음의 완결된 생각 하나를 표현한다. 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.

func someMethod() {
        //주절주절
}
빈 행!!
func zeddMethod() {
        //어쩌구 저쩌구
}
cs


- 세로 밀집도

줄바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻. (ex. 변수 선언)


- 수직 거리

우리는 시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소비한다.

서로 밀접한 개념은 세로로 가까이 둬야 한다. 물론 이 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 

같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. (여기서 연관성이란 한 개념을 이해하는데 다른 개념이 중요한 정도) 

연관성이 깊은 두 개념이 멀리 떨어져 있으면, 코드를 읽는 사람이 소스파일과 클래스를 여기저기 뒤지게 된다.


변수 선언

- 변수는 사용하는 위치에 최대한 가까이 선언한다. 지역변수는 각 함수 맨 처음에 선언한다.


인스턴스 변수

- 반면, 인스턴스 변수는 클래스 맨 처음에 삽입한다. 변수 간에 세로로 거리를 두지 않는다. (위에서 세로 밀집도에서 말했죠?)


종속 함수

- 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. ==> 호출되는 함수를 찾기가 쉬워지며 그만큼 모듈 전체의 가독성도 높아짐. 


func makeName() {
     let name = self.getName()
}
    
func getName() {
        //어쩌구 저쩌구
}
cs

이런식 getName을 호출하는 함수가 있으면, 그 함수 선언 다음에 getName을 배치하는게 좋다는 뜻.

저는 이 방식? 이렇게 하는게 굉장히 좋다고 생각하고, 그럴려고 노력중이에요 :) 


개념적 유사성

- 어떤 코드는 서로 끌어당긴다. 

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

친화도가 높은 요인은 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예임. 변수와 그 변수를 사용하는 함수도 한 예다.



세로 순서

- 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출되는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다. (왜 아까 했던 말 또하지?)


가로 형식 맞추기

- 한 행은 가로로 얼마나 길어야 적당할까? -> 프로그래머는 명백하게 짧은 행을 선호. ==> 그러므로?...짧은 행이 바람직


○ 가로 공백과 밀집도

func makeNumber() {
    var count = 1
    count += 3
}
cs

함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않고, 할당 연산자를 강조하려고 앞뒤에 공백을 준 것을 볼 수 있죠.

이렇게 공백을 넣으면 함 개념이 아니라 별개로 보이기 때문에, 밀접한 개념과 느슨한 개념을 표현한다고 합니다.


들여 쓰기

- 소스 파일은 윤곽도(outline)과 계층이 비슷하다.

- 계층에서 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. 이렇듯  범위(scope)로 이뤄진 계층을 표햔하기 위해 우리는 코드를 들여쓴다. 들여쓰기 정도는 계층에서 코드가 자리잡은 수준에 비례한다. 


- 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다. 

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

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

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

들여쓰기가 없다면 인간은 코드를 읽기란 거의 불가능 하리라.


○ 들여 쓰기 무시하기 

func testMethod() -> String  {
    if self.isHidden { return "Zedd" }
}
    
cs

이런거....

근데 클린코드 글쓴이는 이렇게 안할려고 노력한대요.


팀 규칙

- 팀 규칙이라는 제목은 말 장난이다.

프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 개개인이 따로국밥처럼 맘대로 짜는 코드는 피해야한다. 


역시..이번챕터도 읽으면서 정말..구구절절 맞는말만 하네..라고 생각했어요. 

글 초반에 순히 '돌아가는 코드'가 전문 개발자의 일차적인 의무라고 생각한다면...이라고 했는데, 조금 맘이 바뀌셨나요 :) 


반응형

'공부' 카테고리의 다른 글

Xcode ) Simulator Custom  (4) 2018.04.14
알고리즘 ) Binary Search Tree - 삭제  (6) 2018.04.01
함수객체? 모나드? map???  (0) 2018.03.06
File System Programming Guide  (0) 2018.02.28
Apple의 파일시스템. HFS+와 APFS  (0) 2018.02.23
댓글
댓글쓰기 폼
반응형
Total
4,386,374
Today
0
Yesterday
2,890