규도자 개발 블로그
깨끗한 프로젝트 코드를 위한 규칙. 5S 본문
깨끗한 프로젝트 코드를 위한 규칙. 5S
깨끗하게 유지된 프로젝트 코드는 아무리 강조해도 지나치지 않다. 실제로 수많은 프로젝트들이 해당 프로젝트를 개발하는 것보다 유지보수에 더 많은 인력과 자원을 소모하게 되지 않는가. 깨끗한 코드와 디렉터리 구조로 프로젝트를 유지하기 위한 5S규칙은 아래와 같다.
정리(Seiri) : 적절한 명명법 등과 같은 방법을 사용해 무엇이 어디에 있는지 알아야 한다. 전산화가 이뤄지지 않았던 시절에도 수많은 캐비닛과 파일철, 그리고 정리 규칙들로 수많은 문서들을 체계적으로 분류하여 쉽게 찾아낼 수 있었듯이 말이다.
정돈(Seiton) :
단정함, 또는 체계화라고도 한다. 코드는 누구나 예상하는 위치에 있어야 한다. 당신이나 누군가가 찾는 것이 있을 때 이것은 응당 이곳에 있어야만 한다고 생각하고 그곳을 찾아봤을 때 그곳에 있는 것이다. 만약 그렇지 않다면 다시 정돈해 누구나 예상하는 위치로 옮기기 바란다. "모든 것들은 있어야 할 곳에 있어야 한다."
청소(Sesio) : 작업 공간에서 배선이나 기름, 부스러기나 쓰레기를 치우듯이 과거 이력이나 미래 바람을 기억한 주석 혹은 주석으로 처리한 코드는 제거해야 한다. 당신이 버전관리툴을 사용하고 있다면 말이다.
청결(Seiketsu) : 표준화라고도 한다. 작업 공간을 정리하는 방식에 그룹이 동의하고 그룹 내에서 일관적인 구현 스타일과 기법을 유지한다.
생활화(Shutsuke) : 위 관례를 따르고, 자주 돌아보고 기꺼이 변경하는 것을 의미한다.
조금 생소한 발음일 것이다. 왜냐면 한자의 일본어발음이기 때문이다. 이 5S개념은 애초에 1951년에 TPM(Total Productive Management)이라는 품질 관리론이 일본 업계에 도입되면서 그 안에 있는 5원칙이 위의 단어로 정립된 것이다.
TPM의 특징은 생산이 아니라 유지보수에 초점을 맞춘 품질 관리론이라는 점인데 도입부에서도 말했듯이 이 "유지보수에 집중한다"는 점이 소프트웨어 업계에서 굉장히 필요한 요소로 받아들여진 것 같다.
'소프트웨어 공학 > Clean Code' 카테고리의 다른 글
무슨 값들을 상수(constant)로 지정해야할까? (0) | 2022.04.14 |
---|---|
나만의 코딩 컨벤션 (0) | 2019.04.09 |
좋은 변수이름 정하기 : 피해야 할 변수 이름 (1) | 2018.10.13 |
좋은 변수이름 정하기 : 표준 접두사의 장점 (0) | 2018.10.12 |
좋은 변수이름 정하기 : 상수 이름 (0) | 2018.10.12 |