SQL의 가독성을 높이는 다섯 가지 사소한 습관
https://yozm.wishket.com/magazine/detail/1519/
1. 예약어는 대문자로
- SELECT, FROM, GROUP BY, HAVING, AS, AND와 같은 SQL 예약어를 대문자로 쓰는 습관
- 예약어, 함수 이름 등은 대문자로 써주는 습관을 들이면 쉽게 자신이 쓴 코드를 구분할 수 있다.
2. 행갈이를 자주 하자
- SELECT, FROM, GROUP BY와 같이 한 라인에 다른 절이 있는 코드를 작성하지 않는다.
- 한 라인에 다른 절을 쓰면 각 라인의 예약어만 확인하게 되어 작성자의 의도와 코드 구조를 쉽게 파악할 수 있다.
3. 행갈이를 더 자주 하자
- 코드를 작성하는 것은 주석처리를 할 때 진가를 발휘한다.
- 가끔 쿼리를 쓸 때 어떤 로직을 제외했다가 다시 포함해야 하는 일이 생길 수 있다.
- 예약어에 따라 행갈이를 하기 때문에 무엇이 문제인지 쉽게 파악하여 빠르게 해결할 수 있다.
4. 주석을 쓰자
- 코드를 쓴 의도를 짧게 적어 놓은 습관을 들이는 게 좋다.
- 서브쿼리가 많아지고 코드가 길어질수록 각 코드 단락이 어떤 의도로 작성되었는지 적어 놓아야 다음에 그 코드를 읽었을 때 이해할 수 있다.
- 서브쿼리 단위로 의미 작성
- 추가 설명이 필요한 경우 작성
- 조건이 왜 필요한지, 어떻게 동작하는지 같은 내용 작성
5. Alias를 잘 쓰자
- 주석도 중요하지만, 코드를 잘 써야 전체를 빠르게 이해할 수 있다.
- 변수명을 잘 지어야 서브쿼리가 어떤 동작을 하는지 다시 볼 일이 생기지 않는다.
[인사이트]
5가지 습관의 중요성을 알고 있었지만, 그 동안 귀찮다는 이유로 실천하지 않고 넘어갔었다. 그런데 최근에 내가 이전에 작성한 블로그 글을 다시 읽어보니, 이 습관들을 지키지 않아 다른 블로그에 비해 가독성이 떨어지고 읽기 불편하다는 것을 깨달았다. 앞으로는 내가 작성한 코드가 다른 사람에게도 쉽게 읽히고, 시간이 지나 내가 다시 보았을 때도 쉽게 이해할 수 있도록, 이 5가지 습관을 항상 염두에 두고 지키겠다는 다짐을 하게 되었다.
팀원 전체의 인사이트
[공통 인사이트]
- 가독성 좋은 코드를 작성하는 것의 중요성을 깨달았다. 다른 사람들과의 원활한 협업을 위해 코드를 남들도 잘 읽을 수 있도록 작성 및 정리해야겠다.
- 가독성 좋은 코드를 작성하는 습관을 만들어야겠다.
[의미 있었던 의견]
- 코드를 가독성 있게 작성하는 것도 넓게 보면 데이터분석가에게 중요한 역량인 ‘커뮤니케이션 역량’에 포함되어 있는 것 같다.
- 파이썬과 SQL의 비교: 파이썬은 들여쓰기, 행갈이가 문법적인 면에서 중요하다. SQL은 가독성을 위해 행갈이를 한다.
