현재 프로젝트를 doxygen 으로 문서화할 생각입니다만, 좋은 결정인지 모르겠습니다.
어느정도의 주석처리는 다 하고 있지만, doxygen 으로 열심히 문서화해서 누가 볼지도 잘 모르겠고,
현재 프로젝트가 실험적인 코드들이 많아서 얼마나 수정이 가해질지 잘 모르겠습니다.
가장 중요시 하는 건, 각각의 기술들에 대해 열심히 참고 문헌을 달아보려고 합니다.
이 부분은 어떤 논문을 참고 했고... 뭐 이런게 잘 정리 되면 좋을 것 같아서요.
그런데 만든다고 누가 볼지 참 모르겠습니다. 혹시 개발 중에 doxygen 으로 정리 같은거 하시나요?
더 중요한건 만든다고 누가 보는지요. (저 자신도 안보는데 말이죠.)
물론 만들면서 생기는 이득은 논외로 칩니다. 만들면서 얻는 개발자 측면의 이득이야 분명히 있지만,
아무래도 단순 주석 처리보다는 매우 많은 노력이 들어가니까요.
문서화 열심히 하시나요??
Moderator: 류광
-
- Posts: 480
- Joined: 2006-11-04 16:24
- Location: Creaty Networks
- Contact:
저희는 위키에 있는대로 때려박고 보는사람이 알아서 정리하면서 보고 있습니다..;
너무 관리가 안되다보니, 일단 자료라도 남기고 보자는 마인드로 시작했는데, 의외로 참여율이 높습니다.
너무 관리가 안되다보니, 일단 자료라도 남기고 보자는 마인드로 시작했는데, 의외로 참여율이 높습니다.
세상이 기다리는 나만의 SHOW!
----------------------------------------------
Zeprod 홈 : http://Zeprod.org
Project. Creaty : http://Creaty.net/
Creaty 게임제작 커뮤니티 : http://Creaty.net/game/
----------------------------------------------
----------------------------------------------
Zeprod 홈 : http://Zeprod.org
Project. Creaty : http://Creaty.net/
Creaty 게임제작 커뮤니티 : http://Creaty.net/game/
----------------------------------------------
-
- Posts: 8
- Joined: 2009-06-09 18:49
-
- Posts: 31
- Joined: 2007-08-29 14:51
-
- Posts: 1044
- Joined: 2003-02-18 10:29
- Contact:
제 경험으로만 입각해서 답변할께요.
1. doxygen으로 API reference를 작성하면 확실히 큰 도움이 됩니다. 적은 수고로도 멋진 도움말 문서가 나옵니다.
2. doxygen으로 API reference만 작성하는건 반쪽짜리 도움에 불과합니다. 오히려 개괄적인 사용법과 컨셉을 잘 설명한 (그것도 그림과 함께!) MS 원드 문서가 코드 재사용성에 큰 도움이 되는 것 같습니다.
3. 이상적으로는 위 2가지를 모두 하는게 좋지만, 저건 업무 일정에 따로 설정해서 하는 시간을 잡게 해달라고 위에다 야그해서 진행하는 것이 훨씬 낫습니다.
4. 신입 플머들에게 소스 이해를 시키기를 시키되 시킨 일이 잘 되고 있는지를 평가하는 방법으로 문서화 작성을 지시해도 좋습니다. 일석이조죠.
파는 엔진의 경우 문서화가 매우 잘 되어 있어야 합니다. 저희 엔진의 예를 아래 이미지에 첨부해볼께요.
1. doxygen으로 API reference를 작성하면 확실히 큰 도움이 됩니다. 적은 수고로도 멋진 도움말 문서가 나옵니다.
2. doxygen으로 API reference만 작성하는건 반쪽짜리 도움에 불과합니다. 오히려 개괄적인 사용법과 컨셉을 잘 설명한 (그것도 그림과 함께!) MS 원드 문서가 코드 재사용성에 큰 도움이 되는 것 같습니다.
3. 이상적으로는 위 2가지를 모두 하는게 좋지만, 저건 업무 일정에 따로 설정해서 하는 시간을 잡게 해달라고 위에다 야그해서 진행하는 것이 훨씬 낫습니다.
4. 신입 플머들에게 소스 이해를 시키기를 시키되 시킨 일이 잘 되고 있는지를 평가하는 방법으로 문서화 작성을 지시해도 좋습니다. 일석이조죠.
파는 엔진의 경우 문서화가 매우 잘 되어 있어야 합니다. 저희 엔진의 예를 아래 이미지에 첨부해볼께요.
온라인 게임 서버 엔진 ProudNet
http://www.nettention.com
http://www.nettention.com