[CLEANCODE] 의미있는 이름

2021. 10. 20. 23:29·CLEANCODE
728x90

의도를 분명하게 이름 사용

  • 변수, 함수명을 의도를 분명하게 하면 코드를 이해하기 쉬워짐 
  • for 문 사용시 i j k 를 사용 X

통일성 있는 단어 사용

  • 똑같은 의미에 대해서는 똑같은 단어를 사용하는 것이 중요함
  • 뜻이 같은 비슷비슷한 단어여도 통일이 안되면 오히려 혼란을 줌 
  • 통일성 있는 단어 사용을 위해 팀에서 협의를 하는 것이 좋음

변수명에 타입 금지

1. String addressString -> address 
2. int itemPriceAmount -> itemPrice 
3. Account[] accountArray -> accounts 
4. List<Account> accountList -> accounts, accountList
5. public interface IShapeFactory -> ShapeFactory
6. public class ShapeFactoryImpl -> CircleFactory
  • 변수명에 타입이 존재할 경우 오히려 이해하는데 방해가 되고 오독할 가능성이 오히려 커짐
  • IDE에서 타입 오류를 다 감지하기 때문에 필요가 없음
  • 인터페이스 명시하는 접두어도 사용하면 오히려 주의를 흐트리는 과도한 정보 제공 
  • 인터페이스 구현한 클래스 Impl도 필요 X

패키지, 클래스, 메소드 이름 방식

  • 패키지 : 언더스코어 (_) 사용하지 말기, 소문자로 구성
  • 클래스 : 명사, 명사구로 구성 대문자로 시작 / 카멜케이스 
  • 메소드명 : 동사, 동사구로 구성, 소문자로 시작 / 카멜케이스 

항상 의미있는 단어를 정하여 이름으로 사용하고, 이름에 변수나 인터페이스 명시 하지 말기

저작자표시

'CLEANCODE' 카테고리의 다른 글

[CLEANCODE] 객체와 자료구조  (0) 2021.10.24
[CLEANCODE] 형식맞추기  (0) 2021.10.24
[CLEANCODE] 주석  (0) 2021.10.23
[CLEANCODE] 함수  (0) 2021.10.23
[CLEANCODE] 깨끗한 코드  (0) 2021.10.20
'CLEANCODE' 카테고리의 다른 글
  • [CLEANCODE] 형식맞추기
  • [CLEANCODE] 주석
  • [CLEANCODE] 함수
  • [CLEANCODE] 깨끗한 코드
집한구석
집한구석
  • 집한구석
    tgyun615.info
  • 전체
    오늘
    어제
    • 카테고리 (183)
      • JAVA (38)
      • SPRING (15)
      • KOTLIN (23)
      • NETTY (1)
      • DEVOPS (3)
      • DOCKER (7)
      • KUBERNETES (2)
      • JAVASCRIPT (1)
      • SPLUNK (3)
      • ELK (7)
      • KAFKA (2)
      • GO (4)
      • ALGORITHM & DATA STRUCTURE (9)
      • IDE (5)
      • OS (16)
      • NETWORK (14)
      • GCP (2)
      • AWS (2)
      • DATABASE (10)
      • CLEANCODE (7)
      • OTHER (12)
  • 최근 글

  • 태그

    자바
    docker
    이펙티브코틀린
    JPA
    go
    java
    AWS
    코틀린
    이펙티브 코틀린
    프로그래머스
    IntelliJ
    splunk
    SQL
    클린코드
    ElasticSearch
    cleancode
    엘라스틱서치
    Kafka
    Spring
    Elk
  • 링크

    • github
    • linkedin
    • resume
  • hELLO· Designed By 정상우. v4.10.3
집한구석
[CLEANCODE] 의미있는 이름
상단으로

티스토리툴바