개요
Confluence/Github을 사용해 Code Convention을 맞추고 Code Review를 진행하던 PJT에서 일하다가, 이러한 문화가 없는 PJT에 중간 투입이 되니 필요성을 느끼게 되었다. C# 개발 시 IDE로 Visual Studio를 사용중이어서 가장 많이 쓰이는 CodeMaid를 prettier tool로 제안했다.
코드 규칙을 지키는 문화 확산을 위해 준비했던 것으로, 개발자가 유투브로 설명한 내용을 번역 & 정리한 내용이다.
툴 사용법
-
설치방법 :
상단 메뉴 Extensions > Manage Extensions > online > CodeMaid 검색/설치 > 재시작
옵션 설정 없이도 기본적인 사용 가능 -
설치 후 메뉴 위치 :
1) 코드화면에서 우클릭 > CodeMaid > (기능 선택)
2) Visual Studio 상단 메뉴 Extensions > CodeMain > (기능 선택)
3) Solution Explorer에서 폴더/파일 우클릭 > Cleanup Selected Code
대표 기능 : Cleanup
-
기본사용 - Cleanup Active Document (Ctrl+M, space)
1) using - 안쓰는 using 제거, using 정렬
2) 데이터 없는 #region 제거
3) 비어있는 access modifier 설정(internal, private으로 지정)
4) 줄 바꿈 조정 - 불필요한 줄띄우기(메소드 첫줄, 마지막줄, 중간에 2줄이상) 제거
5) 칸 바꿈 조정 - if (, for (, foreach ( 와 같이 문법 뒤 괄호 앞에 한칸씩 띄우기 -
범위 지정
Cleanup Active Document - 활성화 되어있는 파일
Cleanup Open Code - 열려있는 모든 파일
Cleanup All Code 솔루션의 모든 파일
프로젝트(혹은 특정 범위) 우클릭 - Cleanup Selected Code 지정된 범위의 파일 -
Automatic Cleanup On Save - On/Off
On 해두면 save 시 자동으로 Cleanup 실행
기타 기능
[Digging (Spade)]
- 기본 - Spade (Ctrl+M, .)
1) 파일순서 / 타입순서 / 알파벳 순서 등으로 변경해서 볼 수 있음
2) region 구분 유지
(Delete - region 전체 삭제, Remove Region - 내용은 남겨두고 Region 표시만 삭제)
3) 소스코드와 Spade의 동기화 - 클릭(이동), 접기/펼치기, 순서변경, 삭제
4) 복잡도 - Spade 화면에서 항목 별 오른쪽에 숫자 표시
5) 사용처 확인 - (Spade항목 우클릭 - Find Reference)
[Reorganize]
- 클래스 내부 재정렬 - Reorganize Active Document (Ctrl+M, Z)
[작은 기능들]
- Code Formatting - 너무 긴 경우 줄 정리
- Join Lines - 한 줄로 합치고 싶은 줄을 드래그 한 후 Join Lines 클릭
- Sort Lines - 드래그 한 코드 라인들을 정렬
- Collaspe Recursively - Solution Explorer에서 우클릭한 대상 아래를 모두 접기
- Build Progress - Build 진행과정 퍼센트를 bar로 확인 가능
[Option]
- Cleaning - File Types - Exclude에서 Cleanup 을 제외할 파일 설정
- Reorganizing - Types - 재정렬 순서 지정 (두 타입을 묶는것도 가능)
참고
http://www.codemaid.net/ - CodeMaid 공식 설명 페이지
https://www.youtube.com/watch?v=M8iwCaw61Mo&feature=youtu.be - CodeMaid 개발자의 tool 설명
