IT/Delphi

주석을 달때 주의점

비와바람 2009. 8. 17. 09:12

1. 주석을 단 사람으로 이니셜을 쓰지 말자.

이게 이니셜을 쓰는 사람도 있고, 자기 아이디를 쓰는 사람도 있고 천차만별이다. 그런데, 가끔 보다보면 이게 이니셜등인지, 아니면 잘못친건지 구분이 안되는 인간들이 있다는 문제가...

가장 좋은게 자기 이름이다..


2. 가능하면 주석과 같이 작성한 일자도 기록하자.

특히 대단위 업데이트 작업을 하다보면 주석에 날짜를 넣는게 좋을때가 꽤 있다..


3. 소스 복사시 주석의 작성자 이니셜과 날짜는 없애라.

이거.. 꽤 문제가 생길때가 있다. 내가 한 3년전에 해놓은 건데, 누가 그걸 통째로.. 주석까지 카피를 해서 작업했는데, 그게 문제가 생겼다면... 괜하 나한테 와서 뭐라 그런다. -.-;
내가 한게 아니란 말이지...

설명이야 그냥 써도 상관없겠지만, 원작자, 작성일자등은 그냥 없애라...

Copy Right가 아니라 Copy Left다.. -.-;;