MaintainableCode

UserPreferences

1 개요

유지보수가 쉬운 코드를 작성하려면 어떻게 해야 하는가? 주로 How To Write Unmaintainable Code에서 긁어온 내용들에다 첨삭을 가하는 방식으로 진행할 예정이다.

2 기본적으로 명심해야할 사항

유지 보수를 담당하는 프로그래머를 좌절치 않게 하려면, 그 사람이 어떤 생각을 가지고 있으며, 어떤 입장에 처해있는지를 이해해야 한다.

자신과는 전혀 상관없던 수십만 라인의 프로그램이 눈 앞에 떨어진 것이다. 모든 코드를 이해하기는 커녕, 다 읽을 시간조차 없다. 그는 수정할 부분을 재빨리 찾아서, 수정하고, 빌드하기를 원하며, 수정에 의한 사이드 이펙트(side effect)는 원하지 않는다.

그가 한 순간에 볼 수 있는 코드는 전체 코드에 비해 아주 작다. 작은 부분을 차례대로 읽어나감으로서 프로그램의 전체적인 구조를 볼 수 있도록 하고, 찾고자 하는 부분을 쉽게 찾게 해주고, 수정할 때 신경써야 하는 부분을 적게 만드는 것이 유지보수를 위한 코드의 핵심이다.

3 목록

• /Naming - 변수, 함수, 클래스 이름 등에 관련된 사항
  
• /Documentation - 주석에 관련된 사항
  
• /ProgramDesign - 디자인에 관련된 사항
  
• /CodingStyle - 코딩 스타일과 관련된 사항
  
  
  

4 링크

• 소설처럼 읽히는 프로그램 작성하기
  
• Six ways to write more comprehensible code
  
• Seven Pillars of Pretty Code
  
• The Art of Maintenance Programming
  
• Reducing Dependencies In C++
  

• CategoryDesign