클린코드3 Ch4. 주석 4장은 주석에 대해서 다룬다. 잘 달린 주석은 그 어떤 정보보다 유용하다. 하지만 다른 의미로, 함수의 이름이나 변수의 이름만으로 의도를 정확하게 전달하지 못하고 주석으로 부가적인 설명이 필요하다는 말이 될 수도 있다. 이번 장에서는 좋은 주석과 나쁜 주석에 대해서 알아보자. 목차 더보기 목차 1. 주석은 나쁜 코드를 보완하지 못한다 2. 코드로 의도를 표현하라 3. 좋은 주석 (1) 법적인 주석 (2) 정보를 제공하는 주석 (3) 의도를 설명하는 주석 (4) 의미를 명료하게 밝히는 주석 (5) 결과를 경고하는 주석 (6) TODO 주석 (7) 중요성을 강조하는 주석 4. 나쁜 주석 (1) 주절거리는 주석 (2) 같은 이야기를 중복하는 주석 (3) 오해할 여지가 있는 주석 (4) 의무적으로 다는 주석 (.. 2023. 2. 24. Ch3. 함수 함수는 프로그램의 가장 기본적인 단위이다. 이번 3장에서는 함수를 잘 만드는 법을 소개한다. 누군가 내가 짠 함수 코드를 보았을 때, 너무 길어서, 너무 복잡해서, 함수 이름을 이해하지 못해서, 중복되는 코드가 너무 많아서 등의 이유로 긴 시간동안 이해하지 못한다면 이 글을 읽고 함수를 짜는 방식을 고쳐보는 건 어떨까? 목차 더보기 목차 1. 작게 만들어라 2. 한 가지만 해라 3. 함수 당 추상화 수준은 하나로 4. Switch 문 5. 서술적인 이름을 사용하라 6. 함수 인수 7. 부수 효과를 일으키지 마라 8. 명령과 조회를 분리하라 9. 오류 코드보다 예외를 사용하라 10. 반복하지 마라 11. 구조적 프로그래밍 12. 함수를 어떻게 짜죠? 1. 작게 만들어라 ✅함수는 가능한 한 작게 만들어야 합.. 2023. 2. 24. Ch2. 의미 있는 이름 1장은 클린코드가 왜 필요한지, 대부분의 코드가 왜 복잡해지고 더러워지는지, 클린코드란 무엇인지를 다뤘다. 2장부터는 코드를 클린하게 만들 수 있도록 본격적으로 시작하는 장이며, 이 챕터에서는 주로 이름(변수명, 함수명 등)을 잘 짓는 법에 대해 다룬다. 왜 이름을 잘 지어야 할까? 코드는 나 혼자만의 것이 아니다. 여러 사람들과 일을 할 때, 누군가 내 코드를 보았을 때, 한 눈에 이해할 수 있도록 코드를 깨끗하게 잘 다듬어야 한다. 그 중에 첫 단계가 바로 이름을 잘 짓는 것이다. 목차 더보기 목차 1. 의도를 분명히 밝혀라 2. 그릇된 정보를 피하라 3. 의미 있게 구분하라 4. 발음하기 쉬운 이름을 사용하라 5. 검색하기 쉬운 이름을 사용하라 6. 인코딩을 피하라 7. 자신의 기억력을 자랑하지 마.. 2023. 2. 24. 이전 1 다음
