pdpdds
헤더 파일에 주석 부탁합니다.
최소한 헤더 파일에 클래스의 목적과 클래스의 멤버들의 목적에 대한 간단한 설명이 있었으면 좋겠습니다.
일부는 이름만으로 유추할 수 있는데 일부는 이름만으로는 정확한 목적 파악이 쉽지 않네요(알려면 소스를 다 뒤져야 하는데 이러식으로는 너무 시간 소비가 크네요^^;;;)
예를들면 class SFCGSFPacketProtocol 에서 BOOL AddTransferredData(char* pBuffer, DWORD dwTransferred); 는 이름만으로 유추할 수 있는데 bool GetPacketData(BasePacket* pPacket, char* buffer, const int BufferSize, unsigned int& writtenSize);는 정확하게 어떤 목적으로 어디에서 사용되는지 알기가 애매하네요. 그리고 bool DisposePacket(BasePacket* pPacket); 도 목적과 사용 조건 같은게 궁금합니다(대충은 사용하지 않는 패킷 메모리 해제를 하기 위한 것 같은데).
혼자서 작업을 해온 탓도 있고 계속해서 수정을 하다보니 주석에 인색했던 것이 사실입니다 ^^ 예를 들어 GetPacketData 메소드도 현재 개발중에 있는 부분이라 제대로 정리가 않된 코드 중 하나입니다. 차후에는 개발부분이 완전히 완료되면 커밋을 하도록 하겠습니다. 어떤식의 주석 코드 형태가 좋을까요? 좋은 샘플을 하나 알려 주시면 그 샘플에 맞게 클래스 및 메소드 설명을 추가하도록 하겠습니다.
아직 개발중이니 간단하게 주석 달아주시면 될 것 같아요. 목적과 제한 사항만 알 수 있으면 되니까요. 궂이 형식을 따질 필요는 없을 것 같습니다. 그리고 주석은 헤더 파일에만 달죠(물론 이후에 어느 정도 개발되면 중요한 소스에는 달고요)
예) // 받은 데이터 저장 BOOL AddTransferredData(char* pBuffer, DWORD dwTransferred);