Check style 기초가이드
-
Upload
kim-yoonsub -
Category
Software
-
view
509 -
download
0
Transcript of Check style 기초가이드
Check Style 기초 Guide
SW Maestro 5th / 김윤섭
Check style?
• 협업시 사용되는 코딩 컨벤션을 소스상에서 잡아주는 Eclipse Plug-in
소개
• 공식 페이지 : http://eclipse-‐cs.sourceforge.net/#!/ • 테스트 버전 : V 6.1.1 • 적용 언어 : java • 기본 제공 style(변경 불가능) – Google : 지나치게 불필요한 부분이 많음 – Sun : eclipse 버전과 큰 차이는 없지만 eclipse가 더 유연함 – Sun(Eclipse) : 권장
설치법
–이클립스에서 • Help -‐> Install New Software...
– url 입력 • http://eclipse-‐cs.sf.net/update
– Checkstyle Plugin feature 선택
–이클립스 재시작
기본 설정
1. 본 항목을 클릭하여 checkstyle활성화
기본 설정
2. 본인이 원하는 style 을 선택 (기본: google & sun)
3. style에서 제외할 항목들을 선택
4. 끝
Custom Style 만들기
7
Check style 생성
생성
Style을 xml형식으로 저장
Style 설명 바꾸기Convention 등록/설정
Check style 생성New 버튼을 누르면 생성됨.
2) 설정파일의 이름3) 위치는 사용하지 않는다
4) 설정파일에 대한 설명
5) 설정파일을 드라이브에서 불러온다
1) 설정파일 타입
Check style 생성
Type 종류1.내부 설정파일2.외부 설정파일 import3.원격 설정파일 import4.다른 프로젝트의 설정파일 import
Convention 등록 / 설정
이클립스에서 지원하는 기능들의 code convention들이 나열 되어짐.원하는 모듈을 선택한 뒤, 컨벤션을 설정하여 추가.
Convention 등록 / 설정
• 예를 들어 Method names에 대한 코딩 컨벤션 등록
원하는 컨벤션 형식을 지정한다. 테스트 해 볼수 있는 폼.
Convention 등록 / 설정
생성됨
Convention 등록 / 설정
• 등록 후 최종 OK를 누르면 프로젝트를 re-‐build 가 진행된다.
• ✭확인사항 • style활성화 되어있는지 확인(5페이지 참고) • 새로 만든 설정인지 확인 (6페이지 참고)
14
확인
• method name 컨벤션에 맞지 않으므로 안내 문구가 표시됨.
15
정리
• sun이나 google 코딩 컨벤션이 있기 때문에, custom을 굳이 하지 않고 사용해도 무방하다. • -‐> 하지만, 까다로운 점이 많다.
• 개인적으로 Google의 컨벤션은 까다로운 편 • 검색해보면 Twitter의 CheckStyle.xml 파일도 있다. • 변수, 함수명 등으로 협업에 문제가 있을 시, 간단히 2,3가지의 설정으로 가이드라인을 제시하기에 좋다.
16
참고 사이트
• Check Style 공식 사이트 • http://eclipse-‐cs.sourceforge.net/#!/
• 알고 있어야 할 8가지 정규식 표현 • http://blog.outsider.ne.kr/360
17