코드컨벤션 적용

코드컨벤션 구성

- 디렉토리 구조

- 개발표준 

  - 명명 규칙

  - 코딩 표준

  - 주석 규칙

  - 소스 코드 구조 : 괄호

 

예시

객체 명명규칙
컴포넌트	접두어	사례	비고
Button	btn	btnSearch, btnSave, btnDelete
Check Box	cb	cbAnniv, cbEmp
Combo Box	cbo	cboAnniv, cboEmp
Image	img	imgEmp, imgComp
List	lst	lstName, listEmp
Form	frm	frmSend, frmImp
Input	In	InID, InName
Text Area	ta	taReport, taSummary
Radio	rd	rdGubun, rdType

메소드 명명규칙
메소드 동사	접두어	사례	비고
Search		searchEmpNo
Save		saveEmpNo
Update		updateEmpNo
Delete		deleteEmpNo
Get		getValue
Set		setValue
Generate		generateKey
Calculate		calculateAge
ls		isValid

주석 규칙

<!-- **   *   xxxxx      :      xxxxx   *   xxxxx      :      xxxxx   *   xxxxx      :      xxxxx   *   xxxxx      :      xxxxx   *   xxxxx      :      xxxxx ** -->

---

코드컨벤션 적용 방법

1. 문서화 (사이트, 블로그, 협업툴)

2. 프로젝트 내 적용

2.1. styleCode

2.2. code formatter(code linter)

 

.

.

.

내용 추가 예정입니

---

참고 자료 

- sonarLint VS checkStyle : https://jacobhboy66.tistory.com/41

- 코드컨벤션 설정 : https://hello-judy-world.tistory.com/211

- java 코드컨벤션 적용하기 CheckStyle : https://bestinu.tistory.com/64

- java에서 코드컨벤션 강제 적용 해보기 : https://jacobhboy66.tistory.com/41

- checkStyle 적용하기 : https://yeongchan1228.tistory.com/129

- codeStyle.xml 적용 : https://bobr2.tistory.com/entry/%EC%9E%90%EB%B0%94-%EC%BD%94%EB%94%A9-%EC%BB%A8%EB%B2%A4%EC%85%98-Code-Style-%EC%A0%81%EC%9A%A9

- intelliJ Code Style 적용하기 파일만들기 : https://eroul-ri.tistory.com/26

- 코드컨벤션 적용하기 : https://limsungju.tistory.com/234

- 우아한테크코스 코드컨벤션 : https://programmer-ririhan.tistory.com/337

- 코드컨벤션 예시 : https://overcome-the-limits.tistory.com/5

- 인프런 네이밍컨벤션 : https://www.inflearn.com/pages/infmation-69-20240509?srsltid=AfmBOops-cU1D62VgCzC4mnYwfLGEpkQfzizfhae6LcWvA3V2P10W6CH

- 인텔리제이 코드컨벤션 설정 : https://055055.tistory.com/97

- 코드포매터 : https://nx006.tistory.com/62

- intelliJ naver code convention 적용 : https://velog.io/@nefertiri/%EC%9D%B8%ED%85%94%EB%A6%AC%EC%A0%9C%EC%9D%B4-%EC%9E%90%EB%B0%94-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%BD%94%EB%94%A9-%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0

- code formatter, linter의 차이 : https://empty-cloud.tistory.com/86

- 네이버 캠퍼스 핵데이 코드컨벤션 git : https://github.com/naver/hackday-conventions-java?tab=readme-ov-file