코멘트 작성하는 방법..

[개발]
  • 우리는 책임 있는 프로그래머로서 코멘트를 잘 달아야 할 의무가 있다.
  • 코멘트가 필요없을 정도로 좋은 코드(스스로 문서화 하는)를 작성하라.
  • 코드를 묘사하지 말고, 왜에 대해서 설명하는 코멘트를 작성하라.
  • 과거에 무엇을 했는지 기록하지마라. 그것은 리비전 컨트롤 시스템이 알아서 할 것이다.
  • 나쁜 코드는 문서화하지 말고 다시 작성하라.
  • 명료하고 일관성있게 작성하라.
  • 하나의 사실은 한 곳에만 작성하라.
  • 코멘트는 과거가 아니라 현재 속에서 살아야 한다. 코드가 바뀌었다거나 예전에 뭐가 어땠었다는 기술은 하지 마라.
  • 코드를 변경할 때 그 주변에 있는 코드도 모두 유지보수하라.
2008/01/10 01:28 2008/01/10 01:28
TAG. ,
트랙백이 없고, 댓글 2개가 달렸습니다.

이 글의 트랙백 주소 :: http://mypage.sarang.net/tt/trackback/226

::: 사람과 사람의 교감! 人터넷의 첫 시작! 댓글을 달아주세요! :::

  1. hey [2008/01/10 10:42]  [댓글주소]  [수정/삭제]  [댓글쓰기]

    더불어 안 쓰는 코드 주석처리 좀 안 했으면 좋겠어요. 그냥 지워버리고 로그 잘 달면 얼마나 좋아.

[로그인][오픈아이디란?]

◀ 이전페이지 1 ... 65 66 67 68 69 70 71 72 73 ... 286 다음페이지 ▶