Clean Code

seonja kim·2020년 6월 14일
0

Role for clean code

Indenting

  • 하나의 function은 nested structures를 가질 만큼 크지 않아야 한다.
  • indent level은 두 개 이하로 유지해야 한다.

Line

  • 4줄 이상 가지지 않도록 한다.

Argument

  • number :
    하나의 function은 3개 이상의 argument를 가지지 않도록 한다.
    만약 3개 이상의 argument를 넘길 경우 Object를 만들어서 넘기도록 한다.

  • type :
    boolean을 넘기지 않도록 한다. boolean이 필요한 경우 function을 true / false 두 개로 나누어 사용하도록 한다.
    만약, boolean을 넘길 경우 해당 boolean이 무슨 의미를 가지는 것인지 정확하게 얘기할 수 있어야 한다.

  • Output into Argument :
    결과값을 argument로 넘겨주지 않도록 한다.

예의 없는 코드란

double take : 다시 돌아가서 봐야 하는 코드는 읽는 사람 입장에서 예의 없는 코드이다.
principle of least surprise : 코드를 읽고 놀랄만한 부분이 없어야 한다.

Avoid Switch Statements

switch
{
    case
    case
    case
}

switch statement를 사용할 경우, case 하나만 문제가 있어도 recompile / redeploy할 때 switch 안에 있는 case들 뿐만 아니라 거기에서 나온 모든 기능들을 다시 recompile / redeploy해야 하기에 사용을 지양한다.



Independantly Deploy

사업의 중요부분과 관련된 것이 아닌 GUI부분과 같이 주요 기능은 아니지만 자주 바뀌는 부분들을 수정, 보완하기 쉽게 하기 위해 independantly deploy하게 되고 switch statements처럼 연관고리를 많이 만들어놓을 경우 독립적인 배포가 어려워 매번 모든 것이 다시 배포해야 하는 번거로움이 있으므로 개별적으로 배포할 수 있도록 structure을 제대로 구성하고 코드를 짜야 한다.



Pairs of Functions

profile
Adventurer

0개의 댓글