발표 자료
참고한 글
https://velog.io/@hangem422/clean-code-comment
우선 클린 코드가 뭔지 설명하자면, 클린 코드는
소프트웨어 개발에서 일관되고 가독성이 높으며 유지보수가 쉬운 코드를 작성하는 것을 목표로 하는
개발 철학으로, 아래와 같은 주요 원칙을 따르고 있습니다.
첫째로 가독성은, 코드는 다른 사람이 쉽게 읽고 이해할 수 있어야 합니다.
단순성은, 코드는 간결하고 복잡하지 않아야 합니다.
모듈성은, 코드는 작은 모듈로 분리되어야 합니다.
재사용성은, 코드 중복을 최소화하고 함수 또는 클래스를 재사용할 수 있도록 설계해야 합니다.
테스트 용이성은, 코드는 테스트하기 쉬워야 합니다.
명확성은, 코드는 명확하게 작성되어야 합니다. 모호한 표현이나 불필요한 주석은 피해야 합니다.
효율성은, 코드는 성능적으로 효율적이어야 합니다.
그렇다면 클린 코드를 위해서 주석은 꼭 필요할까요
주석은 왜 써야 할까요
주석은 주로 코드에 관련된 유용한 정보를 주기 위해 사용됩니다.
그렇다면 만약 정보를 줄 필요가 없다면 주석이 필요가 없지 않을까요
아까 전에 말씀드렸던 클린 코드의 주요 원칙 중 하나인 명확성, 코드는 명확하게 작성되어야
한다는 걸 보면, 코드만 명확하게 작성한다면 코드로 충분히 의도를 표현할 수 있을 수도 있습니다.
이와 같이 추상화를 통해 코드를 이해하기 쉽고 명확하게 나타낼 수 있습니다.