개발자의 협업 🗒️코드 컨벤션

안녕하세요 Pard 1기 앱파트, 3기 iOS 김민혁입니다.

Pard는 협업이라는 키워드를 목표로 삼고 달려가고 있는 동아리입니다.

제가 이때까지 경험한 Pard는 나와 다른 분야의 학생들과 협업을 경험하기에 너무나도 좋은 기회이며, 그렇기에 다른 분야의 사람들이 어떠한 방식으로 생각하고, 또, 그들의 어려움은 무엇인지 많은 것을 배울 수 있었습니다.

그러나, 다른 분야와 협업을 하기에 앞서 하나의 프로젝트에는 여러 개발자가 참여하게 됨으로, 다른 분야 뿐만아니라 개발자 끼리도 협업을 잘하는 것이 중요합니다.

그래서 오늘 가져온 것은 코드 컨벤션에 관한 것입니다. 물론, 다른 여러 프로젝트나, 산학 프로젝트를 하고 있는 우리 Pard의 Pardy, Pardo들은 익히 알고 있겠지만, 아직 그렇지 못해 처음 협업을 할 개발자들(Pard 이외에도)이 코드컨벤션에 대하여 알았으면 좋겠다 하는 마음에 글을 작성해 봅니다...

코드 컨벤션이란,

코드를 읽고 이해하기 쉽게 하기 위한 개발자들의 코딩 스타일 규약입니다.

1. 파일구조 및 파일 네이밍규칙

2. import 규칙 (ex: 알파벳 순)

3. 변수 네이밍 및 정의방법 (swift의 경우 let variable: type = value or let variable : type = value)

4. 괄호, 들여쓰기, 줄바꿈, 공백 규칙

5. 파일 구조, 변수 외 패키지, 클래스, 함수, 파라미터, 상수 등의 네이밍 규칙

이 외에도 많은 것들에 대한 규약이 포함되어 있는 문서를 뜻합니다.

코드 컨벤션이 중요한 이유

코드 컨벤션의 목표는 개발자가 '서로의 코드를 읽고 이해하기 쉽게 하자'입니다. 모두가 같은 스타일로 코드를 작성하기에 다른 사람의 코드를 더 이해하기 쉽고 이로써 불필요하게 시간을 들여 코드를 이해하는 일을 줄일 수가 있습니다.

파일명을 예로 들자면, 내가 productListView 와 같은 형식으로 파일명을 작성했는데, 같은 상황에서 다른 사람은 ListProductView와 같은 형식으로 작성을 한다고 하면, 나는 productListView에 해당하는 파일을 찾기 위해서 가장 앞의 글자인 p를 기준으로 파일을 찾기 시작할 것입니다. 또한 폴더 안의 파일들의 이름이 대소문자 가리지 않고 뒤죽박죽 이라면 정리되지 않은 느낌도 있으면서 일관성도 없을 것입니다.

이미 회사에 종사하시고 있는 분들께서는 물론 코드 컨벤션을 많이들 이용하고 계시겠지만, 디스콰이엇을 이용하고 있으신 많은 미래의 개발자 분들께서 코드 컨벤션에 대한 중요성을 아시고, 경험하시고 익숙해 질 수 있으시면 좋겠다는 마음이 이 글을 작성하게 되었습니다.

개발자의 협업에는 github와 같은 좋은 tool들이 있지만, 기획단계의 기본, 상세 설계서와 같은 산출물들 처럼 개발자들의 협업을 위해 이러한 약속들이 얼마나 중요한지를 느끼고 회고하게 되었습니다. 비록 자신의 코드가 훌륭하고, 깔끔하더라도 자만하지 않고, 협업을 잘하는 개발자로 함꼐 성장했으면 좋겠습니다.

사실 제가 적은 코드 컨벤션의 장점은 학생의 기준으로 작성된 것이지만, 저의 짧은 생각으로는 코드 컨벤션의 문서화에 대해 회사의 입장으로는 코드의 일관성으로 유지보수의 측면이 클 것이라 생각됩니다. 그러나 그보다도, 학생인 제가 생각하기로 코드 컨벤션은 개발자가 협업하기 위한 가장 첫번째 순서라고 생각합니다. 그저 말로만 하는 간단한 약속은 코드를 작성하면서 아차 하는 순간에 잊을 수 있으므로 협업읋 하는 학생 개발자들도 네이밍 규칙 및, 파일 구조와 같은 간단한 규칙이라도 코드 컨벤션으로 문서화 하여 개발자의 협업을 경험하며 함께 성장했으면 하는 바람입니다.

비록 코드 컨벤션에 대한 설명은 짧을 수 있겠지만, 익히 많이 알려진 것이므로 검색하시면 많은 정보들을 찾을 수 있을 것입니다. 협업에서 필수적으로 사용되는 것인줄은 압니다만, 학생의 차원에서 많이 경험할 수 없다는 생각에 이렇게 글을 작성해 보았습니다.

읽어 주셔서 감사합니다:)

+. To developers in Pard, 숏커톤과 롱커톤 전 모인 개발자들이 이 코드 컨벤션에 대해서 한번 더 기억하며 간단한 문서로 정리하며 서로 약속을 문서화했으며 하며, 이로인해 더 좋은 협업을 할 수 있으시길 바랍니다. 또한, 우리 Pard에서 추구하는 협업을 힘껏 느끼셨으면 좋겠습니다.