[후기] "개발자의 글쓰기"

나는 사과·2022년 2월 2일
0

독서랄까..?

목록 보기
1/2
post-thumbnail

사내에 이 책이 있어서 평소 글쓰는 것에 대해서 그리고 말을 하는 것에 있어서 생각이 많던 나에게 도움을 줄 수 있을 것 같아서 설 연휴동안 읽어보았다.

읽기 전에 가장 흥미로웠던 목차는... 바로.. 기술 블로그 작성 관련 목차다!!
왜냐하면 이 벨로그를 조금 더 재미있고~ 많은 개발자 분들이 찾아와주는 그런 블로그로 발전시키기 위해서 가장 먼저 읽어보고 싶었다.

하지만.. 다 읽은 후에는 입사한지 6개월 된 응애 ios개발자에게 가장 유익했던 주제는 변수/함수 네이밍 관련 내용, 주석이나 에러 메세지 관련 내용이 가장 유익했던 것 같다!!
(블로그 관련 내용도 좋았지만.. 큰 기대에는 큰 아쉬움이 있기 마련.. 그래도 좋은 내용들이었다.)

평소에도 새 변수를 만들거나 새 함수를 만들 때 이 변수나 함수를 다른 개발자분들이 보기에도 "무슨 역할을 하는 것인지 알 수 있을까?" 라는 생각을 갖고 네이밍을 하기는 하지만 순간 비슷한 역할을 하는 titleLabel 이 중복되는 경우도 있다. 이런 경우 어쩌피 다른 뷰의 titleLabel이니깐 상관없겠지? 라고 생각하는 경우가 대다수였다.
책을 본 이후에, 진짜 상관 없을 수도 있지만 혹시나 하는 경우에 다른 사람이 나의 코드를 볼 경우에 이게 어떤 뷰의 titleLabel인지 확실하게 인지시켜주기 위해서 subViewTitleLabel라든지 subViewTitle이라든지 앞에 접두사를 붙여주는 것도 괜찮을 것 같다! 라는 생각이 들었다.

책에서도 이야기하고 본인도 확실하게 네이밍에 대해서는 내가 붙인 네이밍을 다른 개발자들이 봤을 경우에 이것이 어떤 것을 의미하고 어떤 역할을 하는지 충분하게 알 수 있다면 잘한 네이밍이라고 생각한다. 그래서 정말 사소한 것이지만 지금부터라도 생각하면서 좋은 코딩 습관을 만들어야겠다는 생각이 들었다.

책에서 주석관련해서 네이밍과 연관지어서 좋은 코드들에는 주석이 없다고 말한다. 이유는 변수명이나 함수명에서 어떤 역할인지 나타내기 때문에 주석이 필요없다고 한다. 그렇지만 모든 경우에 주석이 필요없는건 아니고 필요한 경우도 있다고 한다. 바로, 의미가 아닌 의도를 나타내는 경우다.
왜 이 함수가 필요한지? 왜 이렇게 지었는지? 에 대한 의도를 설명하기 위한 용도로 주석다는 것은 강추!! 한다고 합니다.

이것들 외에도 릴리스노트나 기타 개발관련 문서 작성하는 법에 대해서 다루는데 저와 같은 고민을 갖고있거나 개발문서 작성, 글쓰는 것에 대해서 관심이 많으신 분들은 한번 재미로라도 읽어보시는걸 추천합니다. 책을 그리 좋아하지는 않는 편인데도 불구하고 나름 재밌게 읽었습니다~!!😀

0개의 댓글