[실용주의 프로그래머] 결국은 모두 글쓰기 [실용주의 프로그래머] 결국은 모두 글쓰기 -아무리 흐린 먹물이라도 가장 훌륭한 기억력보다 낫다 - 중국 속담 -프로젝트에서 생산되는 문서에는 기본적으로 내부, 외부의 두 종류가 있다.내부 문서에는 소스코드, 주석, 설계와 테스트 문서 등이 포함된다.누구를 독자로 생각하는지, 또는 작가의 역할(개발자 혹은 테크니컬 라이터)이 무엇인지 불문하고, 모든 문서는 코드의 거울이다.불일치가 있다면 중요한 것은 코드다. 좋건 나쁘건. -문서가 애초부터 전체의 일부가 되게 하고, 나중에 집어넣으려고 하지 말라. -코드에는 주석이 있어야 하지만, 너무 많은 것은 너무 적은 것만큼이나 좋지 않다. -일반적으로 주석은 왜 이렇게 되어 있는지, 그 목적을 논해야 한다. 코드가 이미 어떻게 되어 있는지 보여 주기 때문에 이에.. 2018. 11. 16. 반응형 이전 1 다음