클린코드 (2) 썸네일형 리스트형 #클린코드 - 주석 (2) 이번엔 주석을 어떻게 명확하고 간결하게 다는지 살펴볼 것이다. 좋은 주석은 짧은 문장에 많은 정보를 가져야 한다. 1. 주석을 간결하게 하라 1줄으로 설명 가능한 것을 3줄으로 길게 쓰면서 허비하지 마라. 2. 모호한 대명사를 피하라 '위의', '아래의', '지난 버전' 등등의 대명사는 보는 사람마다 다른 의미를 떠올릴 수 있고, 정확한 해석을 하기 위해서는 추가적인 노력이 필요하다. 주석내에서 대명사를 쓸때는 대명사의 의미가 명확하게 표시될 수 있는 문장에서 사용하거나, '위 saveMyName() 함수에서' 와 같이 명확한 대상을 가르켜야 한다. 3. 문장을 다듬어라 '이 URL을 전에 방문했는지에 따라서 다른 우선순위를 부여한다.' 이 문장은 해석 가능하지만 아래 문장을 살펴보자. '전에 방문하지 .. #클린코드 - 주석 (1) 주석 주석의 목적은 무엇인가? 대부분의 프로그래머가 생각하는 주석의 목적이 무엇일까? ‘단순히 아래 나와 있는 코드에 대한 설명’ ‘나중에 설명하기 귀찮으니 써놓는 것’ ‘나쁜 코드를 가리기 위한 변명’ 등등 저는 여러가지 이유로 코드에 주석을 쓰고 있다. 최근 클린 코드에 관한 책을 읽으며 ’주석의 목적은 코드를 읽는 사람이 코드를 작성한 사람만큼 코드를 잘 이해하게 돕는데 있다‘ 라는 문구를 보았다. 이러한 개념에 대해서는 당연히 알고 있었지만 어떻게 해야 좋은 주석을 작성하고 사람들을 이해시킬 수 있을지에 대한 생각은 깊게 해보지 않았다. 오늘은 어떤 주석이 좋은 주석이며 어떤 주석을 작성하지 말아야 할지 알아보는 시간을 가져보도록 하겠다. 설명하지 말아야 하는 것 //유저 Id를 가져오는 함수 c.. 이전 1 다음