프링글이 하는 이야기

1 기본 원칙 1.1 주석작성의 목적은 자기 자신뿐만이 아니라 다른 사람들을 위한 작업이다. (따라서 자기만 알아볼 수 잇는 약어를 사용하거나 농담으로 주석을 작성하면 안된다.) 1.2 주석은 모국어로 기입한다. (아무리 타국어를 잘하는 사람이라도 모국어보다 타국어를 잘할 수 없다. 또한 다른 사람들을 위한 배려이다.) 1.3 주석은 항상 최신으로 유지가 되어야한다. (코드를 변경한 이후에는 반드시 관련 주석을 함께 변경해야한다. 최신이 아닌 주석은 오히려 코드 분석에 큰 방해가 된다.) 1.4 헤더파일의 손상을 최소화한다. (헤더파일은 개발자가 가장 자주 접근하는 파일이다. 무분별한 여러라인의 주석추가로 인하여 헤더파일 자체의 분석능력을 떨어뜨리다면 개발자는 결국 열기 불편한 문서파일만 접근하게 될것이..

2 Doxygen 형식 2.1 소스 파일의 최상단에 파일명, 날짜, 제작자, 설명등을 명기한다. (주석의 방식이/**, */인것에 주의한다. h, inl, cpp등 모든 소스파일에 표기한다.) 예) /** @file RHttp.h @date 2004/11/2 @author 개똥이 RapidEngine™ @brief */ 2.2 클래스 및 구조체 인터페이스 윗부분에 클래스명, 날짜, 제작자, 설명등을 첨부한다. (주석의 방식이/**, */인것에 주의한다.) 예) /** @class CRHttp @date 2004/11/2 @author 개똥이 @brief Http 클라이언트 @warning 몇몇 서버상의 오류로 가능한 업로드는 소문자로 한다. (특히 하나포스 마이홈) */ class CRHttp { … }..

최신 Doxygen 1.4.6 버전의 사용법을 알아본다. === 순서 === 1. 개요 2. 기본설정 3. 전문설정 4. 문서화 명령 사용법 5. Tips ======================================================================== 1. 개요 먼저 Doxygen 을 실행시키면 다음과 같은 UI 가 나온다. Doxygen 을 이용해서 문서를 생성하는 과정은 크게 1) 설정하기 (혹은 설정 불러오기) 2) 설정 저장하기 3) 실행하기 로 나뉘어지며 메인 UI 에서 step1,2,3,4 가 각 과정에 해당한다. 각자가 원하는 스타일의 문서를 생성하기 위해서 알아야 할 점들은 대부분 step1 설정하기에 있으므로 step1 의 메뉴를 중점적으로 파헤쳐 보자...