더북(TheBook)

코드 예시를 넣을 때는 다음 사항을 확인하라.

• 공유 가능한 코드인가: 프로젝트가 오픈 소스가 아니라면 실제 코드 예시를 공유해도 되는지 확인하라. 이미 여러 차례 이야기했지만 그만큼 중요한 사항이다. 클로즈드 소스 코드를 공유해도 되는지 조금이라도 의심스럽다면 나중에 용서를 구하지 말고 사전에 허가를 받아라.

• 꼼꼼히 검토했는가: 블로그 글을 공개하고 부주의한 코딩 실수 탓에 댓글에서 지적받는 것만큼 민망한 일도 드물다. 코드가 이미 프로덕션 환경에 있더라도 꼼꼼히 살펴보고 다른 사람의 검토도 다시 한 번 받아라.

• 현실적인가: 예시용으로 작성한 코드라고 하더라도 현실적이고 안전하게 작성되었는지 확인하라. 독자가 복사해서 붙여 넣어 사용할 수 있기 때문이다. 문법 오류가 없어야 하고 컴파일할 수 있어야 한다. 해당 언어에 온라인 코드 실행 환경이 있다면 그곳에서 확인하라. 더 나아가 실행 환경 링크까지 함께 제공하면 독자가 코드를 쉽게 실행해 볼 수 있다.

• 간결한가: 굳이 실행할 필요가 없는 코드에 논의 중인 부분과 관련이 없는 코드가 있다면 그 부분을 생략하는 것도 고려해 보자. 생략한 부분은 줄임표(…)로 표시하라.