CleanCode

Clean Comment | Formatting

2022.01.24

Comment 란? Code에 대한 사람이 읽을 수 있는 부가 설명. 사람이 Code를 더 쉽게 이해할 수 있게 하는 것이 목적이다. ▶ Clean Commet 원칙 1. Comment는 필요악이다 2. Comment는 대부분의 상황에서 사용하지 말아야 한다. (그러나 Comment를 사용해야 하는 몇 가지 예외 상황이 있다) * 왜 최대한 코멘트를 피해야할까? >> Comment 보다 Code 그 자체가 의미 있어야 한다. - Comment로 부가 설명이 필요하다면 Code가 충분히 의미 있지 못하다는 것이다. - Comment에 의지하기 보다 의미있는 Code를 작성하는 노력이 필요하다 >> Comment는 최신 정보를 담지 못한다. - Code를 변경한다고 Comment 변경도 필수가 아니기 때문에..

🏁 기타/코드프레소 체험단_BE

Clean Method

2022.01.24

≫ 유지보수성 높은 Clean Method의 조건 1. Method를 호출하는 사람이 사용하기 용이해야 한다. 2. Method를 유지보수 하는 사람이 이해하고, 변경하기 용이해야 한다. 3. Method를 유지보수 하는 사람이 테스트하기 용이해야 한다. ▶ Clean Method의 원칙 · 가능한 한 충분히 작아야 한다. · 한 가지를 해야 한다. 그리고 그 한 가지를 잘 해야 한다. · 테스트 가능해야 한다. · 중복이 없어야 한다. Method를 만들 때 Method를 호출하는 사람의 인지적 부하를 최소로 만들어 주어야 한다. 즉, Method를 호출할 때마다 내부 코드를 보거나 API 문서를 보지 않게끔 해야한다는 것이다. 인지적 부하를 낮추는 가장 좋은 방법은 Method의 Parameter의 ..

Clean Comment | Formatting

Clean Method

티스토리툴바