[개념] 코딩 컨벤션이란?

코딩 컨벤션(Coding Convention)은 읽고, 관리하기 쉬운 코드를 작성하기 위한 코딩 스타일 규약을 말한다.

코딩 컨벤션이 왜 필요한가?

코드 작성 규칙들 : 코딩 컨벤션을 준수하면 가독성이 좋아지고, 성능에 영향을 주거나 오류를 일으키는 잠재적 위험 요소를 줄여준다. 특히 규모가 큰 프로젝트일수록 유지보수 비용을 줄이는 데 도움이 된다.

 

1. 정해진 규칙이 있어 명칭이나 구조를 빠르고 정확하게 파악할 수 있다

2. 통일된 규약이 있어 모든 사람들이 코드를 이해하기 쉽다.

3. 유지보수 비용을 줄일 수 있다.

---

대표적인 코딩 컨벤션은 아래와 같다.

네이밍 컨벤션

소스코드와 문서에 있는 변수 이름, 타입 함수 등의 식별자에 사용되는 문자열을 결정하기 위한 규칙이다. 프로젝트, 프로그래밍 언어, 개발 도구 등에 따라 사용되는 종류가 다르다.

 

종류	특징	예시
카멜 표기법	소문자로 시작, 각 단어의 첫문자는 대문자	camelCase / ironMan
파스칼 표기법	대문자로 시작, 각 단어의 첫문자도 대문자	PascalCase / IronMan
스네이크 표기법	각 단어 사이를 언더바_로 구분	snake_case / iron_man
케밥 표기법	각 단어 사이를 구분자-로 구분	kebab-case / iron-man

들여쓰기 컨벤션

사용자의 개발환경에 따라 들여쓰기가 다르게 보일 수 있어 Tab과 Space 중 하나만 사용한다.

주석 컨벤션

• 한 줄은 // 사용한다.
• 여러 줄 주석은 /* */로 작성한다. 주석의 첫 줄과 마지막 줄은 비워준다.

// 한줄 주석

/*
 * 여러 줄 주석은
 * (*) 들여쓰기를 맞춘다.
 */

 

---

📍 참고

https://velog.io/@cada/자바스크립트-코딩-및-네이밍-컨벤션-1편

https://en.wikipedia.org/wiki/Coding_conventions