소스코드 요리사

이 글은 아래 글에서 이어지는 글이며, '읽기 좋은 코드가 좋은 코드다 - The Art of Readable Code' 에서 발췌했습니다. 이전글 : 2017/12/19 - [Study] - 주석을 잘쓰는 방법 : 주석에 담아야하는 내용 (1/2) 아래 내용들은 주석에 들어갈 내용을 찾아낼 때 유용하게 쓰일 수 있다. 코드를 읽는 사람의 입장이 되어라1. 나올것 같은 질문예측하기 작성한 코드를 읽고 뭐하는 코드인지 궁금해 할 것 같은 부분에 주석을 적는다.struct Recorder {vector data;...void Clear() {// 벡터가 메모리를 반납하도록 강제한다. ("STL swap trick" 을 보라.) -> 코드를 보고 왜 data.clear()를 호출하지 않고 빈데이터와 swap ..

업무를 하면서 프로그램을 짜다가 주석을 쓸 때가 많습니다. 그런데, 이 때 이 후에 내가 보았을 때 도움이 되거나 동료가 이 코드를 보았을 때 도움이 되도록 잘 적으려면 어떻게 무엇을 적어야할 지 막막할 때가 많습니다. 책을 읽다가 이런 상황에서 도움을 줄만한 내용이 있어 발췌하여 정리합니다. 아래 내용은 '읽기 좋은 코드가 좋은 코드다 - The Art of Readable Code' 의 주석에 담아야하는 대상 챕터를 읽고 정리한 내용 입니다. 주석의 목적은 코드를 읽는 사람이 코드를 작성한 사람만큼 코드를 잘 이해하게 돕는데 있다.따라서 가치없는 주석도 있다. 적지 말아야할 주석1. 코드에서 빠르게 유추할 수 있는 내용은 주석을 달지말라// 주어진 이름과 깊이를 이용해서 서브르리[h1]에 있는 노드를..