Code Convention - GraduationDku/tastyHub GitHub Wiki

---

Code Convention

---

팀원들과 코드 작업을 진행할 때 코드의 가독성을 증진시키고 코드 스타일을 유지하기 위해 사용된다. 기존의 IDE에서도 코드 포멧팅 기능을 제공한다. 다만 이러한 코드 포멧팅의 경우에는 사용자마다 개인적으로 사용 혹은 IDE에서 제공하는 것이기 때문에 사용자들 간에도 차이가 존재할 수 있다. 그렇기 때문에 이번에 팀 프로젝트를 진행할 때 팀원들간의 일관된 코드 스타일을 유지하기 위해 코딩 컨벤션을 지정하기로 했다. 모든 세세한 항목을 지정하기는 힘들어서 우리 팀의 경우 구글의 코드 컨벤션을 적용하기로 이야기가 되었고 이를 정리하고자 한다.

---

적용방법

---

1.구글 깃허브에서 본인이 사용하는 언어와 IDE, 언어에 맞는 파일(XML)을 다운 받는다. 2.각각의 XML 파일을 Code style 항목에 들어가서 적용(import)하면 된다. 3.설정 후 각 IDE에서 지정된 포멧팅 단축키를 입력하면 지정한 구글에서의 코드 컨벤션이 적용된다.

---

기타 사항

---

컨벤션에서 지정이 된 형식을 제외한 나머지 부분을 정하였다.

1. 네이밍 각 변수 및 메서드의 경우 의미없는 a,b와 같은 형식으로 이름을 지정하는 것이 아닌 해당 변수, 메서드에서 담고자 하는 내용을 반영해서 지정한다. 또한 변수 및 메서드의 이름을 정하는 경우 CamelCase로 작성한다. user의 Id의 경우 '-'으로 구분하는 것이 아닌 userId의 방식으로 CamelCase를 적용하여 작성한다. 그리고 메서드의 이름 또한 동일하게 작성한다.

2. 중괄호 if, else, for, do, while등의 경우 중괄호가 생략이 되어도 되는 경우가 존재한다. 다만 코드의 가독성을 올리기위해 중괄호는 생략하지않는다.