코드컨벤션(Coding Conventions)

강재영's avatar
Aug 14, 2024
코드컨벤션(Coding Conventions)
 
💡
코드 컨벤션(Code Convention)은 코드를 작성할 때 일관성과 가독성을 높이기 위해 지켜야 할 규칙과 지침을 의미합니다. Java에서 많이 사용되는 코드 컨벤션은 Oracle의 Java Code Conventions에 기반을 두고 있으며, 대부분의 팀이나 조직은 이를 기반으로 자신들의 컨벤션을 추가적으로 정의합니다.
 
  • 클래스 이름 (ClassNames)
    • 파스칼 케이스(Pascal Case): 각 단어의 첫 글자를 대문자로 작성합니다.
    • 예시: MyClass, EmployeeManager, UserProfile.
  • 메서드 이름 (methodNames)
    • 카멜 케이스(Camel Case): 첫 번째 단어는 소문자로 시작하고, 그다음 단어들은 첫 글자를 대문자로 작성합니다.
    • 예시: calculateSalary, getUserName, setAge.
  • 상수 이름 (CONSTANTS)
    • 모든 글자를 대문자로 작성하고 단어는 언더스코어(_)로 구분합니다.
    • 예시: MAX_VALUE, PI, DEFAULT_TIMEOUT.
  • 식별자 (IdentiFiers)
    • 카멜 케이스로 작성해야 하며, 이 식별자에는 메서드, 변수, 필드 등이 포함됩니다. 클래스 이름이나 상수와 같은 특별한 경우를 제외하고, 대부분의 식별자는 카멜 케이스를 사용합니다.
    • 예시: userName, orderId, totalAmount.
  • 변수 이름 (variableNames)
    • 지역 변수, 인스턴스 변수, 매개변수 이름 등은 모두 카멜 케이스로 작성합니다.
    • 예시: count, fileName, orderTotal.
 
 

약속

package shop.mtcoding.blog.board; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.GetMapping; class Hello { //클래스명은 파스칼표기법 private final int NUM = 10; // 상수는 올 대문자 } @Controller//식별자 요청을 받을 수 있다. public class BoardController { //GET, POST @GetMapping("/board") public String list() { return "board/list"; } @GetMapping("/board/1") public String detail() { return "board/detail"; } @GetMapping("/board/save-form") //식별자는 카멜표기법X public String saveForm() { // 메서드명은 카멜표기법 return "board/save-form"; } @GetMapping("/board/1/update-form") public String updateForm() { return "board/update-form"; } }
 
💡
클래스는 파스칼
자바 메서드명은 카멜
상수는 올대문자
식별자 요청은 카멜케이스로 하면안된다.
Share article

강재영 블로그