[C#] EditorConfig를 이용한 코딩규칙 정형화
개발자마다 각자의 코딩 스타일이 존재합니다. 다수의 개발자들이 모여 팀 단위로 프로젝트를 진행한다면 코딩 컨벤션 정도는 사전에 맞추고 진행하는 것이 도움이 됩니다.
또한 코딩 스타일에 대한 정형화 역시 사전에 맞추고 진행하면 다른 개발자들이 소스를 봐도 큰 어색함 없이 작업이 가능한 장점이 있습니다. 이를 위해 강제성을 부여해야 한다고 저는 생각하는데요.
이때 VisualStudio의 setting 파일을 이용해서 작업을 진행해도 되지만, 신규 입사자가 생길경우 해당 셋팅작업이 누락되는 경우 강제성을 부여한 코딩 스타일이 어긋나게 됩니다.
이를 대비하기 위해 프로젝트에 종속 시켜서 코딩 규칙을 정형화하는 것이 좋으며, EditorConfig를 이용하는 방법을 정리했습니다.
EditorConfig 파일 생성
진행하고 있는 프로젝트 솔루션에 새파일을 추가하여 줍니다. 이때 템플릿은 editorconfig 파일로 추가 해 줍니다.
저는 .NET 스타일로 진행하였습니다.
EditorConfig 파일 설정
해당 파일을 셋팅하는 것에 대해서 다소 어려움이 있으실 수 있지만,
아래 링크에 각 변수들이 어떠한 역활을 하는지 잘 설명되어 있습니다.
저는 Visual Studio 2017 에서 작업 하였기 때문에 이에 맞는 규칙으로 설정하였습니다.
EditorConfig에 대한 .NET 코딩 규칙 설정 - Visual Studio
EditorConfig에 대한 .NET 코딩 규칙 설정.NET coding convention settings for EditorConfig 이 문서의 내용 --> EditorConfig 파일을 사용하여 코드베이스에서 일관된 코드 스타일을 정의하고 유지 관리할 수 있습니다.You can define and maintain consistent code style in your codebase with the use of an EditorConfig file
docs.microsoft.com
'Program Language > C#' 카테고리의 다른 글
| [C#] SQL Injection 예방 코드 (1) | 2020.02.12 |
|---|---|
| [C#] const와 readonly의 차이 (0) | 2020.02.06 |
| [C#] SonarQube - 정적분석 (0) | 2020.01.29 |
| [C#] MD5를 이용해서 암호화 방법 (0) | 2020.01.13 |
| [C#] CallerMemberAttribute 를 이용한 현재 메소드의 호출자 정보 알아오기 및 성능 비교 (feat. StackTrace) (0) | 2019.12.30 |