[1편] 팀이 생기면, 내가 도움이 될까? - 혼자서도 지킬 수 있는 커밋 컨벤션 https://okky.kr/articles/1518564

이번에는 코딩 컨벤션(코드 작성 규칙)을 정리해봤어요.

나 혼자서도 팀처럼: 준비된 개발자를 만드는 코드 습관

개발자가 되기 위해 혹은 개발자로서 종종 혼자서 프로젝트를 시작하게 되지만, 언젠가 팀이 생기고 협업을 시작할 때 도움이 되는 습관들을 미리 준비할 수 있어요. 혼자서 git 커밋 컨벤션을 연습하듯이요.

물론 코드 작성 규칙은 팀별로 또 언어별로 다르지만, 내가 사용하는 언어의 코드 작성 습관이 잘 만들어져있다면 나중에 팀에 합류할 때 빠르게 적응할 수 있을거에요.

만약 개발팀에 혼자 있다가 누군가가 팀에 합류하는 상황이라면 팀원이 더 효율적으로 적응할 수 있게 만들어주겠죠?

좋은 코드 작성 습관은 코드 가독성과 일관성, 유지 보수, 효율적인 협업 의 장점이 있어요.
가독성이 높은 코드와 일관된 스타일을 지킨다는 것은
다른 개발자에 대한 배려이자 코드 품질에 대한 책임감을 보여준다고 생각해요.

그럼, 어떻게 작성하면 좋을까요?

간단한 코드 작성 규칙: 작지만 큰 차이

"hello, world!" 출력은 대부분의 프로그래밍 언어에서 첫번째 예제죠.

처음 이 예제를 작성할 때, 혹시나 한 글자라도 틀리면 오류 날까봐 띄어쓰기까지 똑같이 작성했던게 기억이 나요.

	public static void main(String[] args) {
		System.out.println("Hello, World!");
	}

주 사용 언어가 Java 라서 모든 예제는 Java 에요 😉

이 작은 예제에서도 간단한 규칙이 있어요.

Java에서 사용하는 코딩 컨벤션 중 간단하면서 눈에 띄는 차이를 만드는 규칙인데요, {를 붙이는 방식이에요.

	//스타일 1
	public static void main(String[] args) {
		System.out.println("Hello, World!");
	}

    //스타일 2
    public static void main(String[] args)
    {
        System.out.println("Hello, World!");
    }

이 두 가지 스타일 중 마음에 드는 스타일이 있으시죠?

중요한 것은 스타일을 통일하고 일관되게 사용하는 것이에요.

Java 공식 스타일 가이드는 스타일 1을 따르는 것을 권장해요. 근데 이제 1999년에 작성된 문서를 곁들인
https://www.oracle.com/java/technologies/javase/codeconventions-contents.html

그리고 하나 더 있는데요, 이미 눈치 채신 분들도 계시겠죠?

바로 들여쓰기(indentation) 인데요, 예제를 드래그해보세요 ⛏️

스타일 1은 tab 이고 스타일 2는 space 에요.

들여쓰기 내용에서도 다양한 내용이 있어요.

4개의 공백(스페이스)를 사용해야 하고, tab은 스페이스 8개여야 하고, ...

이런 코드 작성 규칙은 "코딩 컨벤션" 으로 검색하시면 더 많은 자료를 보실 수 있어요.

Google Java Style Guide: https://google.github.io/styleguide/javaguide.html
Airbnb JavaScript Style Guide: https://github.com/airbnb/javascript
- 자바는 아니지만 공유해봐요 :-)

공개된 많은 코드를 접해본 분들은 이미 각 언어에 맞는 코드 스타일을 자연스럽게 익히셨을 거예요. 그래서 코딩 컨벤션을 찾아보면 '이런 것도 규칙이 있었구나' 하고 새롭게 느낄 수도 있어요😊

음, 그런데, 2024년에 메모장으로 코딩하시는 분이 계실까요..?

IDE가 다 해주잖아

사진 출처: Intellij blog - How to Format Java Code

맞아요. 대부분의 IDE는 이미 자동 포맷팅 기능을 제공하고 있어요.

모든 팀원이 같은 코드 스타일을 유지할 수 있도록, 코드 저장소에 .editorconfig 파일을 공유해 함께 사용할 수도 있어요.

.editorconfig 파일은 다양한 개발 환경에서 코드 스타일(들여쓰기, 줄바꿈 등)을 일관되게 유지하도록 설정하는 파일이에요.

[*.java]                                             # .java 파일 형식에 적용됩니다.
indent_style = tab                         #탭 문자를 들여쓰기 스타일로 사용합니다.
indent_size = 4                              #들여쓰기 크기를 4로 설정합니다.
tab_width = 4                                #탭 문자 너비를 4로 설정합니다.
trim_trailing_whitespace = true  #줄 끝 공백을 자동으로 제거합니다.

마치며

혼자서도 팀처럼, 준비된 개발자가 되는 것은 작은 습관에서부터 시작돼요. 코드 작성 규칙을 지키고 일관된 스타일을 유지하는 것만으로도 협업의 기본기를 쌓을 수 있어요.

이미 이 습관을 실천하고 계신 분들은 지금처럼 계속 이어가시면 좋겠어요. 그리고 이제 취업을 준비하시면서 토이 프로젝트나 포트폴리오를 만들고 계신 분들은 한 번쯤 코드 스타일을 점검해 보시면 좋겠어요. 꼭 구글 자바 스타일에 맞출 필요는 없어요.

중요한 건 자신이 정한 규칙과 일관성을 유지하고, 자신만의 기준을 설명할 수 있는 이유를 만들어 가셨으면 좋겠어요.

여전히 어려운 시기에요. 모두 화이팅💪

[2편] 팀이 생기면, 내가 도움이 될까? - 혼자서도 지킬 수 있는 코드 작성 규칙