[Tip] 주석다는법

 

소스 파일을 하나 새로 만들면 그 앞에 다음과 같은 방법으로 주석달기

//ㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡ
// 파일이름 : CScheduleingInfo.h
// 설명 : 스케줄링 다이얼로그에서 저장한 데이터를 보관하는 클래스
// 노트 :
// 히스토리 : 생성 - 아이언맨, 201.05.25
// Abc 함수추가 - 아이언맨, 2011.05.25
//ㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡ

함수의 경우에는 함수마다 앞에 다음과 같은 방법으로 주석달기

//ㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡ
// 함수이름 : Abc
// 설명 : 이 함수의 역할에 대해 기록합니다.
// 노트 : 기억할만한 점이 있으면 기록합니다.
// 인자 : 인자를 하나씩 설명합니다. 인자의 값을 누가 채워주는지도 명시합니다.
// [IN] int nCount
// [IN] char *pString
// [OUT] int *pResultCount
// 리턴값 : 리턴값의 타입과 의미에 대해 설명합니다.
//ㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡㅡ