글의 목적
이 사양은 프로그램 작성 과정과 관련된 프로그램 파일 및 코딩 스타일을 정의합니다. 본 사양은 Delphi 언어를 기반으로 개발되었습니다.
프로젝트 문서의 구성
Delphi에서 프로그램 파일은 프로젝트 단위에 따라 구성됩니다. 일반적인 프로젝트에는 다음이 포함됩니다.
프로젝트 파일(.DRP 파일)
프로젝트 기본 프로그램의 파스칼 소스 코드가 포함되어 있습니다.
유닛 파일(.PAS 파일)
양식의 모든 선언 및 절차(시간 처리 절차 포함)를 포함하여 프로젝트의 각 양식에 대한 파스칼 소스 파일
양식 파일(.DFM 파일)
양식의 디자인 속성을 포함하는 바이너리 파일입니다. 각 양식의 .DFM 파일과 .PAS 파일은 서로 대응됩니다.
리소스 파일(.RES 파일)
애플리케이션의 실행 파일에 링크되는 컴파일된 바이너리 리소스 파일입니다.
프로젝트 옵션 파일(.DOF 파일)
PProject|Options 메뉴 명령으로 설정된 프로젝트 옵션을 저장합니다.
데스크탑 설정 파일(.DSK 파일)
도구|옵션 메뉴 명령으로 설정된 데스크탑 옵션을 저장합니다.
패키지 파일(.DPK/.BPL 파일)
구성 요소, 클래스, 데이터 및 코드를 공유하는 데 사용되는 파일입니다. 소스 파일은 .DPK 파일이고 컴파일 후에는 .BPL 파일입니다.
상수 정의
콘텐츠:
논리값 정의
상수값의 정의
오류 코드 정의
형식: 한 줄에 하나의 정의. 다음과 같이:
Const<상수>: 유형 = 값 //주석
설명하다:
Const 문을 사용하여 리터럴 값 대신 사용되는 상수를 선언합니다.
예: Const C_SQL:string='T_CD_USER에서 CH_USERER_ID 선택' //사용자 ID 쿼리
Const C_PI:실제 =3.1415926;
구조 유형 정의
내용: 구조 유형 정의
체재:
유형
<타입 이름>//구조 설명 설명
<변수 이름 1>: 변수 유형; //변수 설명 주석
<변수 이름 2>: 변수 유형; //변수 설명 주석;
…
끝;
설명하다:
<유형 이름>은 대문자로 시작하는 문자열입니다. 구조 정의에서 변수 유형을 정의하는 명령문은 두 번째 행과 다섯 번째 열에서 시작됩니다.
예:
유형
TableList=record //시스템 트리 단위 유형 정의
InID: 정수; //단위 번호
이름: 문자열; //유닛 이름
PID: 문자열; //이전 유닛 이름
PT: PTableList; //다음 유닛 유형에 대한 포인터
끝;
프로그래밍 스타일
프로그래밍 스타일은 프로그램의 각 명령문과 주석에 대한 위치 지정 규칙을 지정합니다.
함수/프로시저 스타일
<함수/프로시저> 이름(변수: 변수 유형 [,...]);//함수/프로시저 설명
var
변수 1: 변수 유형; // 변수 설명
변수 2: 변수 유형; //변수 설명;
…
시작하다
성명;
성명;
…
끝 ;
참고: 변수 선언 및 명령문은 세 번째 열부터 작성됩니다. 들여쓰기가 있는 경우 두 열씩 들여쓰고 해당 명령문에 맞게 정렬합니다.
진술 스타일
설명하다:
일반적으로 프로그램 본문에는 최대 10줄마다 하나의 단락 기능 설명이 있습니다.
다양한 진술의 사용을 표준화합니다.
문장의 들여쓰기는 2열 단위입니다.
변수 정의문
var
var_name: <데이터 유형>;
할당 명세서
var_name: = <식>;
조건문
조건이면 //주석
시작하다
성명;
…
끝
else if 조건 then//코멘트
시작하다
성명;
...
끝
그렇지 않으면//댓글
성명;
참고: 실행문이 하나만 있는 경우에는 Begin 및 End 문을 생략할 수 있습니다.
루프 문
//루프 함수 주석
카운터의 경우 := 시작부터 끝까지 수행
시작하다
[성명];
…
끝;
//루프 함수 주석
동안 [조건] do
시작하다
[성명];
…
끝;
//루프 함수 주석
반복하다
[성명];
…
[조건]까지
스위치 문
//스위치 함수 설명
경우 <표현>
<값1>:[문 1];
<값2>:[문 2];
…
<값>: [문 n]
끝;
코멘트 라인
프로그램 코드 유닛 파일 상단에는 이 유닛 파일에 대한 "모듈 설명" 및 "유닛 설명" 설명이 있어야 합니다.
상수, 구조적 유형, 함수/프로시저, 사용자 정의 변수, 코드 세그먼트 함수 블록, 키 명령문 등과 같은 의미 있는 코드 부분의 경우
자세한 내용을 설명하려면 주석 줄이 있어야 합니다.
주석 라인은 설명이 필요한 라인 뒤에 "//XXXXXXXX"로 추가할 수도 있고, 설명이 필요한 라인 위에 추가할 수도 있습니다.
"{XXXXXXXX}"를 사용하여 여러 줄을 추가하거나 "//XXXXXXXX"를 사용하여 한 줄을 추가합니다.
파일 및 양식 이름 지정
의미 클래스 이름 명명 형식
프로젝트 파일 프로그램(.DPR) XXXXXX
유닛유닛(PAS) uXXXXXX
양식양식.이름(.DFM) XXXXXFrm
데이터 모듈DataModule XXXXXDM
각 단위 앞에 추가된 단위 헤더 정의입니다.
{************************************************ * ***
단위 이름:
기능 설명:
작가:
소프트웨어 이름:
버전:
회사 명 : Sword as Dream Software Creation Studio
************************************************** * *** }
소프트웨어 버전 번호 형식 정의:
소프트웨어는 다음 버전 번호 형식을 사용합니다: XXXX
예를 들어, 출시 가능한 프로그램이 완료된 후 버전 번호는 "1.0.0.0"으로 표시됩니다.
첫 번째 숫자: 버전 번호. 참고: 이는 크게 개선된 소프트웨어 버전입니다.
두 번째 숫자: 유지 관리 번호. 참고: 기존 버전에 따라 일부 오류가 수정되었습니다.
세 번째 숫자: 패치 번호. 참고: 프로그램이 일부 오류를 수정하고 새 유지 관리 번호가 형성되지 않은 경우 패치 번호가 사용됩니다.
네 번째 자리: 수정 번호. 참고: 긴급 프로그램 오류가 발생하면 수정된 프로그램은 출시된 프로그램의 버전 번호가 아닌 식별자로 사용됩니다. yckxzjj