문서화 열심히 하시나요??

프로그래밍 일반에 관한 포럼입니다.

운영자: 류광

Locked
비회원

문서화 열심히 하시나요??

전체글 글쓴이: 비회원 » 2009-11-19 13:48

현재 프로젝트를 doxygen 으로 문서화할 생각입니다만, 좋은 결정인지 모르겠습니다.
어느정도의 주석처리는 다 하고 있지만, doxygen 으로 열심히 문서화해서 누가 볼지도 잘 모르겠고,
현재 프로젝트가 실험적인 코드들이 많아서 얼마나 수정이 가해질지 잘 모르겠습니다.

가장 중요시 하는 건, 각각의 기술들에 대해 열심히 참고 문헌을 달아보려고 합니다.
이 부분은 어떤 논문을 참고 했고... 뭐 이런게 잘 정리 되면 좋을 것 같아서요.

그런데 만든다고 누가 볼지 참 모르겠습니다. 혹시 개발 중에 doxygen 으로 정리 같은거 하시나요?
더 중요한건 만든다고 누가 보는지요. (저 자신도 안보는데 말이죠.)

물론 만들면서 생기는 이득은 논외로 칩니다. 만들면서 얻는 개발자 측면의 이득이야 분명히 있지만,
아무래도 단순 주석 처리보다는 매우 많은 노력이 들어가니까요.

사용자 아바타
Zeprod
전체글: 480
가입일: 2006-11-04 16:24
사는 곳: Creaty Networks
연락처:

전체글 글쓴이: Zeprod » 2009-11-19 15:13

저희는 위키에 있는대로 때려박고 보는사람이 알아서 정리하면서 보고 있습니다..;

너무 관리가 안되다보니, 일단 자료라도 남기고 보자는 마인드로 시작했는데, 의외로 참여율이 높습니다.
세상이 기다리는 나만의 SHOW!
----------------------------------------------
Zeprod 홈 : http://Zeprod.org
Project. Creaty : http://Creaty.net/
Creaty 게임제작 커뮤니티 : http://Creaty.net/game/
----------------------------------------------

astra21
전체글: 8
가입일: 2009-06-09 18:49

전체글 글쓴이: astra21 » 2009-11-19 18:50

열심히 하려고 하고있습니다
제가 이어받은 게임은 이러한 문서도 하나도 없고
상용화된 게임이지만 소스도 구버전인것도 있습니다
구버전일때 클라이언트라면 실행해보고 비슷하게 따라하기라고 하겠지만
서버는 문서마저 없음 모가 추가된지 모를때도 있습니다(주석도 안달려 있음 더욱 미치죠;;)
뒤에 이어서 개발하실 하실분들을 위해서라도 어는정도는 해야된다고 생각합니다
ps.제가 한 작업을 몇개월 뒤에 다시 할려고 할때 제가 잊어먹어서 제가 만든 문서보고 한적도 있군요;; 암튼 있음 은근히 좋습니다 여러모로

hyperjingun
전체글: 31
가입일: 2007-08-29 14:51

전체글 글쓴이: hyperjingun » 2009-11-20 09:32

Kingstool 을 깔고 문서화할 부분만 Doxygen주석을 달고 나머지는 그냥 씁니다.
해두면 언젠가는 반드시 도움이 되더군요.
타올라라 나의 소우주여-

imays
전체글: 1044
가입일: 2003-02-18 10:29
연락처:

전체글 글쓴이: imays » 2009-11-20 12:59

제 경험으로만 입각해서 답변할께요.

1. doxygen으로 API reference를 작성하면 확실히 큰 도움이 됩니다. 적은 수고로도 멋진 도움말 문서가 나옵니다.
2. doxygen으로 API reference만 작성하는건 반쪽짜리 도움에 불과합니다. 오히려 개괄적인 사용법과 컨셉을 잘 설명한 (그것도 그림과 함께!) MS 원드 문서가 코드 재사용성에 큰 도움이 되는 것 같습니다.
3. 이상적으로는 위 2가지를 모두 하는게 좋지만, 저건 업무 일정에 따로 설정해서 하는 시간을 잡게 해달라고 위에다 야그해서 진행하는 것이 훨씬 낫습니다.
4. 신입 플머들에게 소스 이해를 시키기를 시키되 시킨 일이 잘 되고 있는지를 평가하는 방법으로 문서화 작성을 지시해도 좋습니다. 일석이조죠.

파는 엔진의 경우 문서화가 매우 잘 되어 있어야 합니다. 저희 엔진의 예를 아래 이미지에 첨부해볼께요.

이미지
온라인 게임 서버 엔진 ProudNet
http://www.nettention.com

Locked