선정 아티클
SQL 가독성을 높이는 다섯 가지 사소한 습관
- 요약
[SQL 작성 시 가독성을 높이는 다섯 가지 작성 습관]
- 예약어, 함수는 대문자
- 행갈이는 가능한 한 자주
- 주석의 활용
- 직관적인 Alias(별칭) 사용
- 조직 내 합의된 규칙 사용
- 주요 포인트 :
-
예약어, 함수는 대문자
예약어, 함수는 DB 종류마다 상이하여 강조 표시가 되지 않는 경우도 있어 대문자로 작성해줘야 구분이 쉽다.
-
행갈이는 가능한 한 자주
한 라인에 다른 절이 있으면 절마다 행갈이를 해야 각 라인의 예약어만 봐도 코드의 의도와 구조를 한눈에 파악 가능하기 때문에 자주 해주는 것이 좋다.
또한, 특정 로직을 제외해야 할 상황의 경우 행갈이를 예약어마다 했을 경우 쉽게 찾을 수 있어 편하다.
-
주석의 활용
특히 서브쿼리, 조건문에 작성 의도 및 작동 방식을 간략하게 기재하면 추후에 확인하거나 다른 사람들이 이해하는 데에도 도움이 된다.
-
직관적인 Alias(별칭) 사용
별칭을 이해하기 쉽게 작성하면 추후 코드를 읽을 때 빠르게 이해 가능하다.
-
조직 내 합의된 규칙 사용
구성원들과 합의된 규칙으로 작성하며 나 이외의 타인도 코드를 볼 것이라 생각하며 작성하는 것이 중요하다.
- 인사이트
실무에서 혼자 업무를 진행하는 경우는 거의 없기 때문에, 항상 내 코드를 다른 사람들이 본다는 생각으로 깔끔하고 가독성있게 작성하여 누구나 이해하기 쉽도록 작성하는 것을 습관화해야겠다는 생각이 들었다.
코드의 가독성을 높이는 이러한 습관들은 몇 초밖에 걸리지 않지만 그 몇 초를 투자하면 나중에 그 코드를 해석하기 위해서 불필요한 시간을 낭비하는 일을 줄일 수 있어 반드시 필요한 일이다.
실제로 직전회사에서는 제품 성적서나 기록서를 수기로 작성했었는데 굉장히 악필인 사람들의 서류를 읽을 때에는 아무도 그걸 해석할 수 없어서, 직접 본인에게 다시 확인해야 하는 번거로움을 느낀 적이 많았다. 이런 부분도 커뮤니케이션의 일환이라고 생각하고 타인과 나를 위해서라도 잘 지키는 것이 좋겠다.
추가로 SQL, 파이썬은 snake_case라고 불리는 소문자 작성 방식을 따르고 있다고 한다. 변수, 테이블, 컬럼명을 작성할 때에는 모든 단어를 소문자로 작성하고 단어와 단어 사이에는 언더바(_)를 넣어 구분하는 작성 방식이다.- 핵심 개념
**✅ 예약어 , 함수 = “대문자”**
**✅ 행갈이 = “자주”**
**✅ 별칭 = “알기 쉽게” (구글링 참고)**
**✅ 주석 = “서브쿼리, 조건문 설명용”**
**✅ 합의된 규칙 준수!**- 용어 정리 :
**[주석]**
한 줄 주석 : `--`
여러 줄 주석 : `/* ... */`[공통 인사이트]
SQL 코드는 협업을 위한 커뮤니케이션이기 때문에 다른 사람과 나 자신도 쉽게 이해할 수 있도록 가독성을 높여 작성하는 것이 중요하다.
의미 있었던 의견
[의미 있었던 의견]
‘snake_case’를 처음 알게 됐다. 찾아보니 명명규칙에는 snake_case 외에도 camelCase, PascalCase, kebab-case 등 여러 가지가 있다는 걸 알았다. 프로그래밍 언어마다 네이밍 컨벤션이 다 다르다고 한다.
“코드의 가독성을 높이는 이러한 습관들은 몇 초밖에 걸리지 않지만 그 몇 초를 투자하면 나중에 그 코드를 해석하기 위해서 불필요한 시간을 낭비하는 일을 줄일 수 있어 반드시 필요한 일이다.”에 공감을 하였다!
“자신이 쓴 코드가 어떤 ‘의도’로 작성 되었는지를 잘 전하는 것이 가독성 높은 코드를 짜는 핵심” 이라는 것이 중요한 핵심인 것 같다:)
“코드의 가독성을 높이는 이러한 습관들은 몇 초밖에 걸리지 않지만 그 몇 초를 투자하면 나중에 그 코드를 해석하기 위해서 불필요한 시간을 낭비하는 일을 줄일 수 있어 반드시 필요한 일이다.” 에 공감하였고 네이밍 컨벤션에 대해 알아봐야겠다고 생각하였다. 또한 내가 쓴 코드가 남에게 어떻게 보여지는 지 또한 중요하다는 인사이트가 제 생각과 비슷한 맥락으로 다가와서 인상적이였습니다.
결국 ‘가독성을 높인다’는 것은’ 내가 이 코드를 어떤 의도로 작성했는지 타인에게 이해시킨다는 것’이라는 인사이트를 읽고 이 점 역시 중요한 부분이라고 느꼈다.
SQL 역시 언어라는 기본적인 지점을 잊어선 안 된다라는 말이 와닿았다. sql은 데이터베이스와 소통하는 도구이며, 데이터 분석을 통해 팀원과 회사와 여러 상대를 대상으로한 커뮤니케이션의 일부이다. 이해하기 쉽고 배려할때 더 나은 소통을 할 수 있겠다.
