코딩하는 일용직 노동자

깨끗한 코딩을 위한 팁 본문

기타

깨끗한 코딩을 위한 팁

bacass 2020. 6. 24. 11:59

이 내용은 제가 즐겨보는 유튜브 노마드 코더의 니콜라스가 말한 내용을 정리한 것입니다.
(www.youtube.com/watch?v=Jz8Sx1XYb04&list=WL&index=11&t=0s)


깨끗한 코딩을 위한 팁 

#1 검색이 가능한 이름을 써라.
가령 하루가 몇초인지를 나타낼때 단순히 코드상에 86400 처럼 매직넘버로 표기하지 말고 const val SECONDS_IN_A_DAY = 86400 같은 상수를 만들어 관리하자.

#2 함수명은 반드시 동사로 써라.
fun userData() 가 아니라 fun makeUserData(), fun loadUserData() 처럼 동사형으로 함수명을 만든다.
또한 함수는 한가지 동작만 하도록 한다.
가령 loadUserData() 는 load 만 해야하고, 다른 동작을 한다면 그 동작에 맞는 함수를 따로 만든다.
함수는 무조건 한가지 행동만 수행하도록 한다.

#3 함수의 인자(argument)는 3개 이하로 한다.
함수가 너무 많은 인자를 받는다면 함수를 사용하는 사람도 혼란스러울 수 있다.

#4 boolean 값을 인자로 함수에 보내는 것을 최대한 방지한다.
boolean 값을 인자로 받는다는 것은 함수안에 if-else 가 있다는 뜻이다.
if-else 의 동작을 각각 다른 함수로 만드는 것이 좋다.

#5 함수의 인자명을 짧은 변수명이나 축약어를 쓰지 않는다.
함수의 인자명을 u, e 같은 축약어를 쓰지 않는다.
user, email 처럼 확실한 단어를 쓴다.


미친듯이 탄력받아서 코딩할때는 우선 자신이 편한 방식으로 코딩을 한다. 그 후에 위의 방식을 따라서 코드를 수정하도록 한다.