EditorConfig 사용하여 코드 컨벤션 정의하기

VisualStudio 상에서 텍스트 편집기 메뉴를 통해 코드 컨벤션을 설정할 수 있다.

하지만 이 설정은 해당 PC에서만 유효하다.

이때 프로젝트에 .editorconfig 파일을 추가하여

같은 프로젝트를 베이스로 작업하는 사람들의 코드 컨벤션을 일관성 있게 유지할 수 있다.

1. 코드 컨벤션을 정의한 .editorconfig 파일을 만든다.

빈 파일을 만들 수도있고 .NET 기본 컨벤션이 들어가있는 파일을 만들수 도 있다.

.editorconfig에 설정되어 있지 않은 항목들은 자연스럽게 2순위(텍스트 편집기 설정 내용) 값을 사용하므로

처음 사용해본다면 빈 파일에 필요한 부분만 추가해서 사용하는 것을 추천한다.

2. .editorconfig 파일을 프로젝트의 적당한 위치에 포함시키고 commit 한다.

.editorconfig파일은 본인 위치 이하의 모든 파일에 영향을 준다.

일부 하위 항목에 별도의 규칙을 적용하고 싶다면

위 예시처럼 해당 하위 항목들을 포함하는 위치에 다른 .editorconfig 파일을 추가해주면 된다.

3. 이후 해당 코드를 받아 작업하는 작업자들은 .editorconfig의 설정을 똑같이 적용받는 상태에서 작업을 하게 된다.

Hyolog