프로그램의 앞부분에 머리 주석을 반드시 달아라
잘 만들어진 주석의 예
/*****************************************************************************/
/* 파일명 : newaccnt.c
/* 작성자 : 1. 출처 : www.gnu.org의 logcount.c
/* 2. 작성 : 소프트웨어 개발 2팀 아무개
/* 목적 : 사용자 로그 기록을 읽어들여
/* 콜 센터에 제공할 통계를 작성한다.
/* 사용방식 : 매일 한번씩 운영체제에 작성한
/* 스케줄러 프로그램 sched.exe에 의해서 자동으로 실행된다.
/* 이 프로그램을 컴파일하여 만든 실행 파일인 newaccnt.exe는
/* 반드시 sched.exe와 같은 디렉토리에 있어야 한다.
/* 사용파일 : userlog.dat를 읽기모도(r)로 읽어 통계를 낸 후에
/* useracnt.dat에 갱신 모드 (w)로 통계를 기록한다.
/* 제한사항 : 1. userlog.dat이 사전에 반드시 먼저 작성되어 있어야 한다.
/* 만약, 작성되어 있지 않다면 logcount.exe 파일이 제대로 작동하는지 점검한다.
/* 2. 이 프로그램은 반드시 새벽 2시 이후에 작동되어야 한다.
/* 만약 스케줄러 프로그램인 sched.c를 수정하는 경우에 이 시간을 고치지 말것.
/* 오류처리 : 1. 각종 오류가 발생한 경우에 오류 로그파일을
/* errlog.dat로 작성하고 바로 종료한다.
/* 이력사항 : 1. 2002년 3월 10일 최초 작성
/* 2. 2002년 6월 5일 스케줄러 프로그램과 연동되도록 수정
/*****************************************************************************/
/************** 이력사항 *****************************************/
/* v 1.0, 1990.10.1, 통신연구소, 아무개, 최초의 통신모듈을 작성하다.
/* v 1.1, 1990.11.1, 통신연구소, 아무개, callprooc()를 개선하여 속도를 높이다.
/****************************************************************/
다양한 주석의 형태
/* 한 줄 주석은 프로그램의 본문 주석에 많이 사용된다. */
/* –>주의 : 오류 메시지 처리 확인 요망 <–*/
/*>>>>>>>>>>>>> 정밀 계산 루틴 <<<<<<<<<<<<<*/
/*
* 여러 줄에 걸친 주석을 이런 식으로 작성할 수 있다.
* 이런 꼴의 주석은 특별히 강조할 사항은 아니지만
* 긴 문장으로 장황하게 설명하여야 할 때 사용한다.
*/
/*
* 이 모듈은 입력값을 검증한다.
* —————————————————————–
* 줄을 만들어 주석내용을 구분하기도 한다.
*
*/
/********************************************************/
/*!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! 경고 (Warning) !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!*/
/********************************************************/
/* 이 프로그림은 특별히 주의를 요한다. 열차의 제어
/* 모듈이기 때문이다. 모든 수치를 정밀하게 검증할
/* 필요가 있으면 수십 차려 이상 테스트해야 한다.
/********************************************************/
/*****************************************/
/******************************************
/**** 주의사항 : 절대로 이 프로그램에서는 ******
/**** 부동 소수점 연산을 하여 근사치를 ******
/**** 사용하면 안된다. 반드시 정수형면수만******
/**** 사용하라. 형 변환이 일어나서도 안된다*****
/******************************************
/*****************************************/
한 줄 주석과 주석 상자를 구분하라.
변수 사전 작성요 주석을 달아라
int area; /* 면적 : 지금 시공할 건물의 대지 면적을 계산한다.*/
int wide; /* 넓이 : 대지의 동서방향의 가로길이, 미터단위로 계산한다. */
int height; /* 높이 : 대지의 남북방향의 세로길이, 미터 단위로 계산한다.*/
의사 코드를 프로그램에 기입하라
프로그램의 목적을 주석으로 달아라
/**********************************************/
/* 언제 작성일 : 2004년 2월 10일 */
/* 어디서 장 소 :
/* 누가 작성자 :
/* 무엇을 코드성격 : php 코드로 약 20여줄
/* 왜 작성사유 :
/* 어떻게 작성환경 : APM
/**********************************************/