허원철의 개발 블로그

이번 글은 클린코드에 대한 세번째 글입니다. 주석 클린 코드를하는데 주석은 걸림돌이 될 수 있습니다. 왜냐하면 코드는 진화하는데 주석은 오랫동안 방치되는 경우가 대부분입니다. 1) 주석보단 코드로 의도를 표현합니다. (메소드명으로 행위를 명확하게 전달 합니다.) 2) 좋은 주석 - 법적인 주석 (라이센스 등) - 정보를 제공하는 주석 - 의도를 명료하게 밝히는 주석 - 결과를 경고하는 주석 - todo 주석 - javadocs 3) 나쁜 주석 - 중복 주석 - 오해할 여지가 있는 주석 - 의무적인, 이력을 남긴 주석 - 함수나 변수로 표현할 수 없으면 주석을 달지 않습니다. - 너무 많은 정보 - 모호한 관계 형식 맞추기 1) 적절한 행을 유지합니다.- 위에서 아래로 서술적으로 쓰도록 합니다. (책에서는..

이번 글은 '클린 코드 시작하기'에 이은 글입니다. 의미 있는 이름 짓기 1) 이름을 명명할 때 명확하게 의도가 드러나도록 합니다. ex) 학생 이름12String studentName; ------------------- (O)String nm; ---------------------------- (X)cs 2) 흡사한 이름을 사용하거나 유사한 개념을 다르게 표기하는 행위는 피하도록 합니다. 1Map studentList; ------------------------ (X)cs 3) 의미가 있게 구분합니다.4) 검색하기 쉬운 이름을 사용합니다. 12345if ( getDayOfWeek() == 1 ) --------------- (X) private static final MONDAY = 1;...if..

클린 코드 Clean Code국내도서저자 : 로버트 C. 마틴(Robert C. Martin),박재호 / 이해영역출판 : 케이앤피북스 2010.03.11상세보기 아는 분으로 부터 '클린코드' 라는 책을 접하게 되었습니다. 원래는 전부 읽고 전체적인 내용을 포스팅해보려고 했으나, 500페이지가 넘는 분량을 한 포스팅에 넣기에는 좋은 내용도 많았고 철학적인 얘기가 많은 터라 조금씩 나눠 포스팅해보려고 합니다. 그래서 클린 코드란 무엇인가? 짐작하시겠지만 깔끔한 코드를 말합니다. 아마 어느 게발자던지 클린코드를 싫어하는 분은 없으리라 생각됩니다. 프로젝트를 하게되면 당연하게 팀을 꾸리는 등 2명 이상의 개발자가 투입되어 소스를 공유하며 코드 작업을 합니다. 여기서 같이 작업할 동료 개발자에게나 작업이 끝나고 ..