[SW 유지보수성 향상을 위한 Clean Code] Clean Naming (2)

✨ 이 글은 [ 코드프레소 Java 웹 개발 체험단 활동 ] 내용입니다 ✨

💜 코드프레소 이러닝 강의 수강 중 - SW 유지보수성 향상을 위한 Clean Code 💜

😎 아래의 링크를 통해 프리미엄 IT 교육 서비스, 코드프레소를 확인해보세요 😎

https://www.codepresso.kr/

프리미엄 IT 교육 서비스 - 코드프레소

---

Coding Rule

• SW 개발 가이드라인 및 규칙의 모음
• SW의 유지보수성 및 신뢰성 등 향상을 위해 준수가 강력히 권장된다
• 각 언어 별로 다양한 단체/기업에서 발표되었다
• Coding Convention, Coding Standar, Coding Style Guide 등으로 불린다

 

 

Coding Rule의 종류

 

 

 

언어 별 Coding Rule

 

 

Coding Rule Example

• 사소한 것들도 규칙을 만들어서 문서화 하였다

 

 

Coding Rule의 준수 여부 확인

• Code Review
  • 작성된 Code를 작성자 외의 리뷰어가 읽으며 다양한 피드백을 주는 활동
  • Code 및 SW 산출물에 대한 리뷰는 품질을 향상시키는 강력한 활동이다
  • Coding Rule 뿐만 아니라 Best Practice, 더 나은 해결책 등을 논의할 수 있다
  • Static Analysis 와 같이 진행하면 더욱 효율적인 리뷰가 가능하다
• Static Analysis
  • SW를 정적 타임 또는 빌드 타임에 분석하는 기술이다
  • Coding Rule 위반, 잠재 결함, 모듈간 의존성 등을 분석한다
  • 언어 별, 무료/유료 정적 분석 도구가 존재한다
  • 무료) IDE, CppCheck, CheckStyle, PMD, PyLint, JSLint, ESLint, SonarQube
  • 유료) Coverity, Klockwork, QAC

 

---

Clean Naming Summary

• SW 엔지니어는 Code를 읽고 이해하고 수정하는데 대부분의 시간을 사용한다
• SW 유지보수를 효율적으로 하기 위해서는 높은 가독성이 필수이다
• 이해하기 쉬운 좋은 이름은 읽는 사람의 인지적 부하를 최소화시킨다
• SW 모든 요소들은 좋은 이름이 필요하다
  • Variable / Constant
  • Method / Function
  • Class / File
• 가장 중요한 것은 "이 이름을 내 동료가 쉽게 이해할 수 있을까?" 하는 질문을 계속해서 던지는 것이다
• 또한 동료들과 함께하는 지속적인 개선과 그러한 문화의 정착이 가장 중요하다!