써야지 써야지 하면서도.. 막상 작업할땐 기록을 안해두게 되더라구요;;;
그냥 비밀게시판 하나 돌려야 될거같습니다. 분류 잘해서;; ㅋ

소스에 주석으로.. 정리합니다. ㅎㅎ;;

일단...
너무 과한 주석은 오히려 가독성을 떨어 뜨릴수 있기 때문에 조심해야 합니다.

주석은 되도록이면.. 함수나 클래스 ㅤㅇㅟㅆ쪽에 요약해서 정리하고,
함수 위 같은 경우는 몇줄 내에서 요약해서 정리하는것이 가장 좋습니다.

되도록이면 주석을 줄이면 좋은데....
주석으로써 프로그램을 설명하지 아니하고.. 함수나 변수명, 클래스 구조등으로 코드가 이해되도록 짜는 것이 가장 좋습니다.

객체지향 프로그래밍을 하면 좋은점 중에 하나가 주석을 좀 줄일수 있다? 입니다.
예를 들어 페이지를 생성하는 함수가 있다고 하면..

객체지향에서는
$page = new PageCreator($page_name);
$page->print();

이런식으로 구조를 잡아서 소스코드를 적어주면.. 굳이 주석이 필요없이..
아!! 페이지를 생성하는 클래스에서 $page_name이 페이지를 출력해 주는 것이구나..
라고 직관적으로 이해 가능합니다.


물론 절차지향에서도 가능합니다만 함수명을 잘 적어 줘야 겠죠..

fucntion createPageXXX();

이런식으로 적거나.. 어떤 형태든 어떠한 페이지를 생성한다는 정보를 함수명에 적어주면 직관적으로 이해 가능합니다.

그래서 되도록이면.... 주석을 안적어도 되도록 프로그래밍 하는것이 가장 좋은 방법 같습니다.


외적으로..
개발일지 보다는 프로그램 명세서를 만드는 것이 가장 좋습니다.
명세서라고 하면 거창해 보이지만.. 클래스별 .. 함수별.. 사용설명서 입니다.
그냥 전체적인 사용설명서를 만들어도 됩니다.
나중에 다른사람이 수정하려고 했을때.. 이 명세서 정도만 보면.. 대충 어떤 프로그램인지 이해가 가는 정도면 됩니다.

클래스의 사용법과, 함수의 사용법 등을 문서화 하고,
자식 클래스 부모클래스의 명확한 역할이나.. 함수의 명확안 역할 등을 체계적으로 문서화 해야 하지만..

말처럼 쉬운것이 아니죠...^^;;

가장 좋은 것은..
문서와 주석이 필요 없도록.. 프로그램을 만드는 일입니다. ㅋㅋ

^^

프로젝트 하나 끝날때 마다 홈페이지에 메뉴얼 같이 한번 정리하고..
하는 습관을 들이는것이 좋은데....

저도 못하고 있습니다.
들기 힘든 습관이더라고요.. ㅎㅎ;;

인간의 뇌에는 끝없이 들어갑니다~

저는 어디에 뭐가 있는지 다 알지요.

다만 어디에 무엇을 두지 않았다는 것 뿐 !

아원님 글가지고 한참 고민중..
그럼 당최 뭘했다는거지? 라고 ㅠㅠ

주석이 최고인듯~~ 강추

나중에 보면 이게 뭐지 할때가 있죠.. 간단하게라도 주석을 달면 좋긴 한데 귀차니즘 땜에

글게여.. 저도 주석을...

저도 작업일지의 필요성을 절실하게 느껴요~
플래시 초보 + php 초보다보니
한창 플래시하다 php 만지려고 보면 도대체 어디서 무엇을 어떻게 했더라.....
또 한창 php 하다 플래시하려고 보면 도대체 이 액션이 어디서 어떻게 나온거지.....

아~~ 어려워요~~ ㅜ.ㅠ

주석은 필요하죠.

혼자만의 개발+디자인 이라면 몰라도 타 분과 공동 작업을 할때는 최소한

이 위치에 무엇이 들어가야 한다는 이정표(?) 역활은 하니

간단한 주석은 필수가 아닌가 합니다.

변수 체계야 자신이 구분하기 쉽고 남도 알기 쉬운 변수명으로 하는게 제일 무난한듯 합니다.

클라이언트에게 신뢰를 주기 위해서라도 코드내 주석보다는
별도의 작업일지를 적는게 좋습니다.
후임자가 정리해서 보기도 좋구요..

코드 수정 내역, 추가 내역에 대한 간략 정리, db필드 추가 변경에 대한 간략정리
그리고, 수정된 프로그램의 기능과 사용법 등을 간략히 정리해놓으면 됩니다.

혹시 다시 의뢰를 주셔서 기능을 더 추가해야 하는 경우도 있으니까요.. 작업 내역서를 정리해두는게 좋습니다.

소스에는 필요한 만큼의 주석만 다는게 좋죠. .너무 많이 달면 오히려 가독성이 떨어져서 안 좋습니다.