개발자의 글쓰기

개발자가 글쓰는 거의 모든 경우에 대해서 다루고 있는 책입니다.

개발자는 머니 머니해도 가장 많이 쓰는 글이 코딩이겠죠.

그래서 인지 코딩 글쓰기를 초반에 많이 다뤄요.

특히 와 닿았던 내용은 코딩 할때 단어 하나 하나의 의미를 정확히 이해하고 적절한 변수/함수/클래스 등의 이름을 지어주어야 겠죠. 역시 코딩에 있어서 가장 중요한 것은 가독성을 좋게 할 수 있는 훌륭한 작명입니다.

Clean Code에서는 훌륭한 작명의 가장 중요한 요소를 기술적 소양 즉 교양을 꼽고 있죠.

이 책에서도 비슷하게 설명하고 있어요.

 

책에서 소개한 네이밍 특징들 관련 글인데 재미있게 보았습니다.

https://brunch.co.kr/@goodvc78/12

오픈소스의 네이밍 특징들

가장 와 닿았던 네이밍 관련 내용을 소개할게요.

 

• 비슷한 듯 다른 듯, 단어 선택이 중요
  • stop, end, finish, pause, suspend, hold
    stop : 잠시 중단 한 것이어서 언제든지 시작 할 수 있다.
    end : 완전히 중단되어서 재시작 할 가능성이 전혀 없다.
    finish : 끝장을 본 상태여서 재시작을 고려할 필요도 없다.
    pause : 아주 잠시 일시적으로 중단된 것이어서 금방이라도 다시 시작할 것 같은 상황.
    suspend : 다음 단계의 시작을 중단한 것이다.
    hold : 어떤 의도가 있어서 중단한 것이다.
  • get, retrieve, acquire, fetch
    get : 어떤 값을 돌려받아서 반환하는 함수에서 사용.
    retrieve : 검색해서 가져온다는 뜻.
    acquire : 독점한다는 뜻.
    fetch : 현재 값을 가리키는 포인터가 다음 값으로 이동한 것을 가져온다는 뜻.
  • set, init, register, create
    set : 값을 변경하거나 설정하는 함수에서 사용.
    init : 초기화 설정일 경우 사용.
    register : 이미 정해진 값을 집어 넣는 것이다.
    create : 정해진 틀이 없으므로 먼저 틀을 만들 때 쓴다.
  • change, modify, revise
    change : 내용을 단순히 바꾸는 것이다.
    modify : 잘못된 것을 바로잡을 때 쓴다.
    revise : 기존에 없던 새로운 정보나 아이디어를 덧붙여 기존 내용과 달라졌음을 분명히 할 때 사용한다.

작명 뿐만 아니라 훌륭한 코드 작성법을 이책에서도 다루고 있어요. Clean Code의 일부분 만을 다루고 있지만 핵심을 잘 집어서 설명하고 있네요.

 

웹 개발을 중심으로 예를 들고 있어서 공감이 잘 안되는 부분도 있지만 가볍게 읽기에는 전반적으 괜찮은 책이었습니다.

코드 작성 뿐만아니라 에러메시지 작성, 릴리스 문서, 장애 보고서, 개발 가이드 작성, SI 제안서 작성, 기술 블러그 작성등의 주제로 폭넓게 다루고 있습니다.