Refactoring/Clean Coding Skill4 클린코더스 강의 내용 정리 #004 - Correct Comment ? (올바른 주석 작성 방법) 서론 보통 개발을 할 때 유지보수를 위해 주석을 달거나 또는 잊어먹지 않기 위해 적는 경우도 있다. 이번 챕터에서는 이러한 주석들이 올바르지 않게 사용하는 방법에 대해 지적하고, 올바른 사용 방법에 대해 강의한다. 이 강의를 듣고 필요한 부분을 정리한다. Coding Standards에 대해 조직이 일정 수준의 크기가 되면 관료적인 문서화를 요구한다. >> 필요하다. 대신, 결국엔 그 문서를 보기보단 소스 안에 해당 내용을 더 잘 녹일 수 있느냐가 중요하다. 코드내에서 명확하게 작성되어있지 않으면 헤매는 것은 문서가 되어있다해도 매 한가지다. (문서의 양은 광대하다.) Coding Standards가 코맨트 작성을 강요하게 된다면 예시에서의 Comment 작성 부분을 보면, 메서드의 이름과 중복적인 내용.. Refactoring/Clean Coding Skill 2022. 4. 11. 클린코더스 강의 내용 정리 #003 - Function Structure 서론 이번 글에서는 함수들의 구조에 대한 내용을 듣고 정리하려고 합니다. 한번 알아봅시다. Function Structure ? Arguments 문제1 - 인자가 많아지면 복잡도가 증가한다. 상황에 따라 다르겠지만 보통은 인자 3개를 최대로 보고 설계한다. 이를 해결할 수 있는 방법은 뭐가 있을까? 1. 좋은 이름을 갖는 Setter를 쓰자. 2. Java Bean Pattern을 사용한다. 3. Builder Pattern을 적용한다. 가장 추천하는 방법은 Builder Pattern을 사용하는 것이다. 아래의 예로 보자. Builder Pattern 예시 Builder Pattern 적용 전 Builder Pattern 적용 후 적용 후 JUnit 테스트 Builder Pattern을 적용 후 확실.. Refactoring/Clean Coding Skill 2022. 4. 8. 클린코더스 강의 내용 정리 #002 - Function 서론 이번 편에서는 제목에서 알 수 있듯 함수(Function)에 대해 강의들은 내용을 정리하려한다. "Function 의 개념과 역할을 알고 리팩토링 하자" 1. 함수는 한가지의 일만 해야한다. 2. 잘 지어진 서술적인 긴 이름을 갖는 함수들로 유지해야한다. 3. 더 작아질 수 없을 만큼 작아야 한다. 4. 큰 함수를 보면 클래스로 추출할 생각을 해야한다. 5. 클래스는 일련의 변수들에 동작하는 기능의 집합이다. 6. 메서드 추출 후 불필요한 괄호는 제거한다. > 괄호는 하나 이상의 책임을 갖는다는 증후를 표현한다. 위의 내용들을 조합하여 강의에서 리팩토링 하는 것을 볼 수 있는데, 정말 쪼갤 수 있을 때까지 쪼개는데 여기서 가장 중요 포인트는 쪼갤 때마다의 변수 및 메서드의 이름이다. 이름을 정말 한.. Refactoring/Clean Coding Skill 2022. 4. 5. 클린코더스 강의 내용 정리 #001 - OOP 서론 클린 코드에 요즘 부쩍 관심이 많다. 좋은 강의를 찾기 위해 이곳저곳 돌아다니다가 백명석님의 클린코더스 강의를 보게되었다. 이 강의는 필자가 짧게 훑어보고 여러 평들을 찾아본 결과 8년전에 업로드한 영상임에도 불구하고 여전히 현직 개발자들에게 좋은 영상을 제공해줄 것이라 생각이 들었다. 해당 강의는 따로 이동시간 (출 퇴근)에 시청할 예정이며 느낀점에 대해서만 간략히 정리해 보려 한다. 첫번째 강의는 OOP에 관련된 내용이다. "기계가 이해할 수 있는 코드는 어느 바보도 작성할 수 있다. 하지만 인간이 이해할 수 있는 코드는 잘 훈련된 SW 엔지니어만이 작성할 수 있다." 위의 말에 대해 격히 공감하는 바이다. 필자도 회사에서 레거시 코드들을 수정을 해야할 일이 생길 때면 정말 막막하다. 어디서부터.. Refactoring/Clean Coding Skill 2022. 4. 5. 이전 1 다음 💲 많이 본 글