포트폴리오/게임스쿨 졸작

9. 문서화 작업도 빼먹으면 안돼지요. - 독시젠작업

codehunter 2010. 6. 7. 00:52


논리적 구조화 작업도 테스트까지는 끝냈고 문서화작업도 더이상 늦추면 안될듯 하다. 슬슬 시작해야겠다.. (이미 늦었음)

원칙은 이미 유명한 블로그인 아래의것을 따르기로 했다.
http://a.tk.co.kr/130

그중에서 쓰기 쉬운 몇가지만 고르면
- 소스 파일의 최상단에 파일명, 날짜, 제작자, 설명을 명기한다.
- 클래스 및 구조체 인터페이스 윗부분에 클래스 명, 날짜, 제작자, 설명 등을 첨부한다.
- 클래스 / 구조체 멤버 변수 주석은 공백 1칸을 띄우고 "///<" 를 사용한다.
- 일반 함수는 헤더에 "///"을 사용하고 추가 설명, 리턴 값 및 인자에 대한 필요하다면 구현부분에 추가 설명을 입력한다. 

// 파일주석
/**
    @file    RHttp.h
    @date    2004/11/2
    @author    채경석(kyuseo99@chol.com) RapidEngine™
    @brief
*/

// 클래스주석
/**
    @class    CRHttp
    @date    2004/11/2
    @author    채경석(kyuseo99@chol.com)
    @brief    Http 클라이언트
    @warning 몇몇 서버상의 오류로 가능한 업로드는 소문자로 한다. (특히 하나포스 마이홈)
*/

- 참고로 디렉토리명은 한글로 되어있는걸 어떻게 처리하는지 ... 예전에 회사에서 처리했었던거 같기도 하고... 일단 걍 영어로   바꿔서 하고있다.