반응형

로버트C마틴 3

[클린코드][4장] - 주석

안녕하세요 Dibrary입니다. 클린코드 4장은 코드를 작성하면서 같이 기록하는 주석에 대한 내용입니다. 주석도 의도하지 않게, 읽는데 방해가 되거나 하는 요소가 될 수 있으니 깔끔하게 작성하고자 할 때 참고하시면 좋을 듯 합니다. 1. 코드로 의도를 표현하자 코드를 설명하는게 아니라 코드가 무슨 목적으로, 무슨 기능을 하기 위한건지 주석으로 남기자는 것입니다. 2. 함수나 변수로 표현할 수 있다면 주석을 달지 마라 즉, 변수나 함수 이름으로 해당 내용 표현이 된다면 주석이 필요 없을 것입니다. 주석을 달지 않도록 코드를 작성하는 것이 가장 기본입니다. 3. 주석과 주석이 설명하는 코드는 둘 사이의 관계가 명확해야 한다 주석이 관련 코드를 설명하는 게 아니라 넘어오는 값의 상태나, 해당 함수 동작 이전의..

프로그래밍 2022.04.09

[클린코드][3장] - 함수

안녕하세요 Dibrary입니다. 클린코드 책 3장은 함수라는 이름으로 시작합니다. 1. 함수는 무조건 작게 만들자 여기서 작게의 의미란, 하나의 함수가 하나의 기능만을 가지게 하라는 의미입니다. 조건문, while문 안에는 가능하면 한 줄 정도로 코드가 작성된 것이 좋습니다. 중첩 구조가 생길 정도로 함수가 커져서는 안 됩니다. 만일 의미있는 이름으로 함수의 일부 혹은 다른 함수를 추출할 수 있다면 그 함수는 이미 여러 작업을 하는 셈입니다. 객체지향 5원칙 중에 하나로 '하나의 객체는 반드시 하나의 동작만을 책임진다'는 것이다. 함수가 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 합니다. 2. 코드는 위에서 아래로 이야기처럼 읽혀야 좋다 아래, 위 반복적으..

프로그래밍 2022.04.03

[클린코드][2장] - 의미있는 이름

안녕하세요 Dibrary입니다. 클린코드를 읽고 계속 생각할 내용을 정리 해 두고자 합니다. 코드를 작성하면서 문득 '코드를 더 클린하게 할 방법이 없을까' 하고 떠오를 때마다 참고할 생각입니다. 1. 변수, 함수의 의도를 분명하게 밝히자. 2. 일관성이 떨어지는 표기법은 피하자. 3. 널리 쓰이는 단어를 다른 의미로 사용하지 말자. 4. 이름이 달라진다면 의미도 달라져야 한다. 5. 이름 길이는 범위 크기에 비례해야 한다. 검색을 할 때 특정 단어를 검색하면 관련 함수만 몇 개 서칭결과로 나와야 찾기가 용이합니다. 모든 함수마다 단어를 공통으로 사용했다면, 서칭결과가 매우 많이 나오겠죠? 6. 인터페이스 이름에 접두어 붙이지 말기. 굳이 차이를 주겠다면 "클래스이름 + Impl" 로 붙이는걸 추천합니다..

프로그래밍 2022.03.27
반응형