디스 프로그래머 (This Programmer)

나만의 코딩 컨벤션 본문

소프트웨어 공학/Clean Code

나만의 코딩 컨벤션

디스 프로그래머 2019. 4. 9. 19:36

내가 코드를 작성할 때 중요하게 생각하는 것이 있다. 정확성은 프로그램이 가져야할 필수요소이고 애초에 정확성이 없다면 프로그램으로서의 가치가 없으므로 딱히 강조하지 않겠다. 그밖에 중요하게 생각하는 건 바로 간결성과 가독성이다. 그 중에서도 특히 중요한 건 가독성이라고 생각한다.

 코드는 결국 사람이 읽기 때문이다. 코드는 결국 다시 읽힌다. 그사람은 당신의 팀원일 수도, 또 당신 자신일 수도 있다. 만약 옛날에 무아지경으로 마구마구 작성해놓은 코드가 다시 필요하다고 할 때 마구잡이로 조사놓은 변수이름들과 코드를 보면 어떤 느낌일까. 예전의 당신이 원망스러워질 것이다.

 나는 이러한 경험을 몇 번 겪고 나서 나만의 일정한 규칙을 정해서 변수를 작성하기 시작했다. 그 이후로는 다른 클래스나 다른 파일에서 어떠한 변수를 참조하는 데에 자동완성이 되지 않고 기억이 나지 않아도 '나라면 이렇게 작성했겠구나'하는 막연한 생각으로 코드를 작성해나가도 내가 스스로 정해놓은 규칙이 있어 중간중간에 참조를 하지 않아도 내 생각에서 크게 벗어나는 법이 없어 작업능률이 향상됐다. 이것은 부단 변수 뿐만이 아니라 html코드를 작성할 때의 클래스, 아이디, 네임을 작성할 때에도 적용되며 데이터베이스에 KEY : VALUE형태로 저장해놓은 옵션값이나 메타값 등 KEY값의 조회가 필요한 경우에 특히나 좋은 효과를 발휘한다.


그런 의미로 나만의 코딩 컨벤션, 즉 규칙들을 여기에다가 하나하나씩 정리해놓으려 한다. 본 블로그 소프트웨어 공학란에 있는 좋은 변수 이름 정하기라는 게시물들과 궤를 같이 한다고 보면 되겠다. 애초에 위에 쓴 문단도 내가 옛날에 썼던 해당 게시물에서 긁어온 것이다.

get function

get method는 무조건 해당 정보를 반환하는 형태로만 사용한다. 계산하거나 데이터를 삽입하는 등의 행위는 일어나지 않는다. 패러미터를 받지 않고 만약에 같은 데이터의 다른 형태가 필요하다면 frontend에서 조작하거나 다른 접미어를 붙인 get mothod를 새로이 작성한다.

set function

set method또한 무조건 해당 정보를 저장하는 형태로만 사용한다. 계산이나 조작 등의 행위는 일어나지 않는다.

calc function

다수의 값들 혹은 단일 값을 특정한 공식을 이용해 계산하고 난 값을 반환받기 위해 사용한다.

init function

init method는 대상이 되는 정보를 필요한 형태로 초기화시킨다. set method로 저장시키기 전에 일정한 데이터포멧을 유지하기 위해서, 혹은 calc method를 사용하기 전에 데이터 포멧을 일치시키기 위해서 사용한다.

draw function

draw method는 html태그나 jQuery, jsx등을 이용해서 직접 요소를 그릴 때 사용한다.


0 Comments
댓글쓰기 폼