결론 주석을 작성할 시간에 함수명, 변수명을 이해하기 쉽게 수정하거나 좀 더 간결하게 코드를 짜는 방법에 대해 고민하는 게 좋다👍 1. 주석을 최대한 쓰지 말자 ✔ 주석은 나쁜 코드를 보완하지 못한다. ① 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. ② 이는 곧 작성자가 의도를 명확히 표현하지 못했다는 것을 뜻하기도 함 👉 난장판을 주석으로 설명하지 말고 개선하는데 시간을 보내자 ✔ 주석은 방치된다. ① 코드의 변화에 따라가지 못하고, 주석은 방치된다. ② 방치된 주석은 뒤에 읽는 사람에게 혼용 야기 할 수 있다. 👉 관리 하지 못 할 거면 자제하는 것이 낫다. 2. 좋은 주석 👍 1) 법적인 이유로 다는 주석 //Copyright (C) 2003,2004,2005 by Obje..

해당 장을 통해 중복👎, 가독성👍, 재사용성👍 할 수 있는 함수 작성 방법에 살펴 보았다. 1. 함수명 ✔ 동사 + 명사 # init public void initData(){..} // 데이터 초기화 # is/has/can public boolean isNumber(){..} // 숫자 여부 판단 public boolean hasData(){..} public boolean canOrder(){..} # create public Board create(){..} // 새로운 객체 생성 후 리턴 # find public Element findElement(int number){..} ✔ 전치사 + 명사 || 전치사 # to public String toString(){..} // String 변환 pub..

의미 있는 이름 1) 의도를 분명히 밝혀라 2) 그릇된 정보를 피하라 3) 의미 있게 구분하라 4) 발음하기 쉬운 이름을 사용하라 5) 검색하기 쉬운 이름을 사용하라 6) 인코딩을 피하라 7) 자신의 기억력을 자랑하지 마라 8) 기발한 이름은 피하라 9) 한 개념에 한 단어를 사용하라 10) 말장난을 하지 마라 11) 해법 영역에서 가져온 이름을 사용하라 12) 문제 영역에서 가져온 이름을 사용하라 13) 의미 있는 맥락을 추가하라 14) 불필요한 맥락을 없애라 Google Java Naming Gudie - 5. Naming 번역 https://google.github.io/styleguide/javaguide.html#s5-naming Google Java Style Guide 1 Introducti..

클린코드란 성능이 좋은 코드 의미가 명확한 코드 가독성이 좋은 코드 중복이 제거된 코드 나쁜 코드 1) 성능이 나쁜 코드 불필요한 연산이 들어가서 개선 여지 있는 코드 2) 의미 모호한 코드 이해가 어려운 코드 ( ex. 네이밍과 그 내용이 다른 코드 ) 3) 중복된 코드 비슷한 내용이 중복되는 코드 → 버그💣 발생 가능성 증가 나쁜 코드가 나쁜 이유 1) 깨진 유리창 법칙 🔳 나쁜 코드는 깨진 유리창처럼 계속 나쁜 코드가 만들어지도록 한다. 깨진 유리창 하나를 방치해 두면, 그 지점을 중심으로 범죄가 확산되기 시작한다는 이론으로, 사소한 무질서를 방치하면 큰 문제로 이어질 가능성이 높다는 의미를 담고 있다 ( 위키 백과 참조 ) 2) 생산성 저하 🕛 기술 부채를 만들어 수정을 더 어렵게 한다. ( + ..