kyuseo의 게임 프로그래밍

독시젠(Doxygen) 형식으로 작성한 헤더(*.h) 파일의 코딩 스타일 모습 본문

C++ 개발

독시젠(Doxygen) 형식으로 작성한 헤더(*.h) 파일의 코딩 스타일 모습

kyuseo 2008. 3. 28. 18:09

개요..

 

제가 주로 애용하는 독시젠(Doxygen) 형식으로 작성한 헤더(*.h) 파일의 코딩 스타일 모습입니다.

 

프로그래밍 스타일 작성시 참고하세요.

 

참고 : Kyuseo's C++ 독시젠을 활용한 주석 작성 스타일 가이드라인(규칙)

 

 

스크린샷

 

 

 

소스코드의 모습

 

// Copyright (c) kyuseo, dpdpdp, Fungrep co.,ltd All rights reserved.

 

/**    

    @file    QSeeTalkHelper.h

    @date    2008/3/28

    @author 채경석(kyuseo99@chol.com)

    @brief    

*/

 

#pragma once

 

/**

    @class    CQSeeTalkHelper

    @date    2008/3/28

    @author 채경석(kyuseo99@chol.com)

    @brief    

*/

class CQSeeTalkHelper

{

public:

    CQSeeTalkHelper();

    ~CQSeeTalkHelper();

 

    void SetText( LPCSTR szText ); ///< 문제를설정한다. : ( ) 등의구문이포함된다.

    LPCSTR GetText(); ///< 정답을얻는다. : ( ) 등의구문을제거되었다.

 

    BOOL SetCompleteText( char ch ); ///< 문자를입력한다.

    LPCSTR GetCompleteText(); ///< 완성된문자열을얻는다.

    BOOL IsComplete(); ///< 문제풀이가완료되었는지검사한다.

 

protected:

    CString m_strText; ///< 전체문제

    StringArray m_sa; ///< 단어별로잘라진단어가저장된다.

    IntArray m_iaBold; ///< 강조구문

 

    CString m_strCompleteText; ///< 정답을맞춘문제

    int m_nCompletePos; ///< 정답맞춘위치

};