[250220] SQL 가독성을 높이는 다섯 가지 사소한 습관

 

SQL 가독성을 높이는 다섯 가지 사소한 습관

요약

 

SQL은 들여쓰기와 띄어쓰기를 강제하는 언어가 아니기 때문에 어떻게 쓰냐에 따라 읽기 힘들 수도 있다.

 

1. 예약어는 대문자로

 

2. 행갈이를 더더더더 자주 하자

 

3. 주석을 쓰자

• 코드를 쓴 의도를 짧게라도 적어 놓는 습관을 들이는 게 좋다. 서브쿼리가 많아지고 코드가 길어질 수록 이해하기 어렵기 때문이다.
• 주석은 서브쿼리 단위로 쓸 수도 있고 case, if 조건문 이나 where 절 필터링 조건을 쓸 때도 적어주는 것이 좋다.
• 예시

- 서브쿼리의 단위로 의미를 적어주기

- 조건에 적는 주석의 경우, ‘이 조건은 이거다(What)’는 의미가 없다. 컬럼이름에 대한 설명이나 추가 설명이 필요한 경우 적어주는 게 좋다.

- ‘조건이 왜 필요한지(Why)’, ‘어떻게 동작하는지(’How)’ 같은 내용을 자세하게 적어주면 좋다.

 

4. Alias를 잘 쓰자

※ Alias : 칼럼, 테이블, 서브 쿼리, where절 등에 별칭을 붙여주는 것 (AS와 같이 사용)

• 서브쿼리, 컬럼 Alias를 x, a, t 등으로 쓰지 말자.
• Alias 작명이 고민된다면 ‘변수명 짓기 팁’을 검색해보자.

5. 합의된 규칙 (가장 중요!!!)

• 가장 중요한 것은 내가 같이 일하는 사람들과 합의된 규칙이다.
• 아무리 좋은 변수명 짓기 규칙이 있더라도 기존 코드 규칙을 무시할 수 없는 법!

코드를 나말고 누군가도 볼 생각으로 작성하고 정리하는 것이 중요하다.

 

주요 포인트

 

SQL은 가독성이 중요하다. 들여쓰기, 띄어쓰기, 행갈이, 주석 등을 잘 활용하면 코드의 가독성을 높일 수 있다. 하지만 가장 중요한 것은 팀 내 규칙을 따르는 것이다.

 

인사이트

 

어떻게 보면 말이나 문자는 아니지만 코드도 팀원들과의 커뮤니케이션 도구라는 생각이 들었다. 코드를 작성할 때 단순히 기능만 구현이 하는 것이 아니라 다른 사람들이 쉽게 이해하고 유지 보수 할 수 있어야 한다는 점에서 협업과 가독성이 중요하다는 것을 다시 한번 깨달았다.

 

SQL 가독성을 높이는 다섯 가지 사소한 습관 | 요즘IT