C 표준 도서관 사전

1..1의 용도

소프트웨어 개발 과정에서 코딩된 작업량은 상당히 크다. 같은 프로젝트에 참여하는 사람들은 자신의 프로그래밍 경험과 습관을 가질 수 있으며, 다양한 스타일의 프로그램 코드로 인해 유지 관리가 복잡하고 어려워질 수 있습니다. 코드의 가독성을 높이기 위해 시스템의 안정성을 높이고 유지 관리 및 업그레이드 비용을 절감하며 이 사양을 특별히 작성하여 개발자의 프로그래밍 작업을 통합합니다.

1.2 구분자

이 사양은 응용 프로그램, 웹 페이지, 데이터베이스 개발자 및 관련 프로그램 테스터를 포함한 모든 개발자에게 적용됩니다.

1.3 참조 표준

GB/T 1 1457 소프트웨어 엔지니어링 용어.

GB 8566 컴퓨터 소프트웨어 개발 사양

GB 8567 컴퓨터 소프트웨어 제품 개발 설명서

2. 쓰기 요구 사항

2. 1 일반 코드 규칙

가독성 원칙은 프로그램의 좋고 나쁨을 평가하는 데 선호되는 것으로, 기교가 없어도 프로그램의 가독성을 보장해야 하며, 기교를 지나치게 추구한다고 해서 프로그램의 가독성을 희생해서는 안 된다.

기능 독립 원칙. 각 프로그램 블록은 하나의 독립 기능만 수행하는 반면, 각 독립 기능은 하나의 프로그램 블록에서만 수행되며, 가능한 한 낮은 커플링과 높은 내부 집계가 가능합니다.

힌트는 간결하고 모호함을 피해야 한다.

힌트 또는 경고 메시지는 사용자에게 오류의 원인과 복구 방법을 정확하게 알려주는 지침이 있어야 합니다. 프롬프트 및 경고 대화상자에서는 표준 사양을 사용해야 합니다.

바로 가기 키는 사용자의 작업 습관에 맞게 정의되어야 합니다.

프로그램을 처리하거나 오래 기다려야 하는 경우 사용자에게 기다리라는 진행률 막대를 표시해야 합니다.

삭제와 같은 일부 민감한 작업은 실행 전에 사용자에게 확인을 요청해야 합니다.

2.2 변수, 함수, 프로그램 및 제어에 대한 명명 규칙.

2.2. 1 변수 이름 지정

변수 이름 지정은 [범위] [데이터 유형] [사용자 정의 이름] 규칙에 의해 정의되며 헝가리 이름 지정 방법을 따릅니다. 변수가 필요한 범위와 데이터 유형은 그 이름을 보면 시각적으로 알 수 있다.

헝가리 명명 규칙:

배열 배열

B BOOL (int) Boolean (정수)

부호 없는 문자 (바이트) 별 부호 없는 문자 (바이트)

C 문자 (바이트)

바이트 수

Cr 색상 참조 값 색상 (참조) 값

X (short) x (short) 의 CX 카운트 세트

Dw DWORD (부호 없는 긴 정수) 이중 단어 (부호 없는 긴 정수)

F flags flag (보통 여러 자리 값) flag (보통 여러 자리 값).

Fn 함수 Function

G_ 글로벌

H 핸들 핸들

I 정수

긴 정수

긴 포인터

클래스 a 데이터 멤버의 M_ Data 멤버.

짧은 정수 짧은 정수

포인터

S 문자열 문자열

0 으로 끝나는 문자열.

텍스트 메트릭 텍스트 규칙

U 부호 없는 int 부호 없는 정수

Ul 부호 없는 긴 정수 (ULONG) 부호 없는 긴 정수.

W 자 (부호 없는 짧은 정수) 부호 없는 짧은 정수

X, y x, y 좌표 (짧은 정수) 좌표 값/짧은 정수.

V 텅 비어 아무것도 없다

행동 범위:

범위 접두어 예

글로벌 범위 g_ g_Servers

멤버 변수 m_ m_pDoc

문자열이 없는 로컬 범위

데이터 형식

VC 공용 접두사 목록

접두어 유형 설명의 예

Ch char 8 비트 문자 chGrade

Ch TCHAR 16 비트 유니코드 유형 문자 chName

부울 변수

N int integer (크기는 운영 체제에 따라 결정됨) nLength

Unint 부호 없는 정수 (운영 체제에 따라 크기가 결정됨) nLength

W 단어 16 비트 부호 없는 정수 wPos

길이 32 비트 부호 있는 정수 l 오프셋

32 비트 부호 없는 정수

메모리 모듈 포인터, 포인터 변수 pDoc

긴 포인터

32 비트 문자열 포인터

32 비트 상수 문자열 포인터

32 비트 유니코드 유형 상수 포인터

창 객체 핸들

Lpfn (*fn) () 콜백 함수 포인터가 리콜되는 원거리 포인터.

콜백 함수 lpfnAbort

2.2.2 함수 및 프로그램 이름 지정

함수 본문 또는 프로시저 이름은 대/소문자를 혼합하여 기능을 설명하기에 충분해야 합니다. 또한 함수 이름은 InitNameArray 또는 CloseDialog 와 같은 동사로 시작해야 합니다. 자주 사용되거나 긴 프로젝트의 경우 표준 약어를 사용하여 이름 길이를 합리화하는 것이 좋습니다. 일반적으로 32 자 이상의 변수 이름은 VGA 모니터에서 읽기가 어렵습니다. 약어를 사용할 때는 응용 프로그램 전체에서 일관성을 유지해야 합니다. 한 프로젝트에서는 이따가 Cnt 를 사용하고, 조금 있다가 계산하면 불필요한 혼란을 초래할 수 있다.

직접 작성한 함수의 경우 시스템 키 함수의 경우 함수 구현 섹션 위에 다음과 같은 형식으로 함수 정보를 표시해야 합니다.

//= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

//함수 이름: InsureHasOutputInfo

//함수 설명: 정확한 출력 정보를 확인합니다.

//입력 매개변수: nproductive: 해당 제품 ID 입니다.

//출력 매개변수: void

//작성 날짜: 00-2-2 1

//수정일: 00-2-2 1

//작성자: * * *

//추가 지침:

//= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

사용자 정의 유형

많은 사용자 정의 유형이 있는 대규모 프로젝트에서는 일반적으로 각 유형에 고유한 3 자 접두어를 지정해야 합니다. 이러한 접두사가 "u" 로 시작하면 사용자 정의 유형을 처리할 때 쉽게 식별할 수 있습니다. 예를 들어 ucli 를 사용자 정의 고객 유형 변수의 접두사로 사용할 수 있습니다.

참고: 비일반 변수의 경우 정의할 때 기록해 두고 변수 정의를 가능한 한 시작 부분에 배치합니다.

이름 지정 제어

사람들은 오브젝트 유형을 쉽게 식별할 수 있도록 일관된 접두사로 오브젝트 이름을 지정해야 합니다.

VC 공통 매크로 정의 명명 목록

접두어 기호 유형 기호 예제 범위

IDR_ 여러 자원 공유의 유형 식별 * * * IDR _ mainframe1~ 0x6fff

Idd _ dialogidd _ spell _ check1~ 0x6fff

HIDD_ 대화상자 기반 컨텍스트 도움말 hidd _ spell _ check0x20001~ 0x26ff

IDB_ bitmap 자원 (bitmap) IDB _ company _ logo1~ 0x6fff

Idc _ cursoridc _ pencil1~ 0x6fff

IDI_ 아이콘 자원 (아이콘) IDI _ 메모장 1~0x6FFF

도구 모음이나 메뉴 모음의 ID_, IDM _ command item id _ tools _ spelling 0x8000 ~ 0xdfff

HID_ command 컨텍스트 도움말 hid _ tools _ spelling0x18000 ~ 0x1dfff

IDP_ message box 프롬프트 텍스트 자원 IDP _ INVALID _ PARTNO 8 ~ 0xDFFF.

HIDP_ 메시지 상자 컨텍스트 도움말 hidp _ invalid _ part no 0x30008 ~ 0x3dfff

IDS_ string 자원 (string) ids _ copyright1~ 0x7fff

IDC _ dialog 의 제어 자원 IDC_ Recalc8 ~ 0xdfff

2.3 소스 코드 규칙

2.3. 1 스타일 규칙: 프로그램 계층이 들여쓰기 형식으로 저장됩니다. 주기, 판단 등의 계층을 시각적으로 볼 것을 요구하다.

중첩된 각 함수 블록에 대해 탭 들여쓰기 (4 개의 공백으로 설정할 수 있음) 를 사용하여 중괄호는 조건문의 다음 행에 있어야 합니다. 이는 별도의 행이므로 괄호는 한 줄에 하나씩 배치됩니다. 대부분의 경우 반팽창 플래그에 주석이 있어야 합니다. 예를 들면 다음과 같습니다.

If (조건 1)

{

While (조건 2)

{

… .....

… .....

}//end while (조건 2)

}//끝 if (조건1)

또는

If (조건1) {

While (조건 2){

......

......

}//end while (조건 2)

}//end if (조건 1)

2.3.2 연산자 앞뒤에 공백을 사용해야 합니다.

2.3.3 배열 아래 첨자와 함수 매개 변수를 구분하는 쉼표 뒤에 공백을 추가해야 합니다.

2.3.4 go to 문 사용을 엄금한다.

2.3.5 데이터베이스 작업은 표준 SQL 문만 사용할 수 있으며 키워드는 대문자여야 합니다 (예: SELECT, WHERE 등). ) 및 데이터 요소 (테이블, 필드, 뷰 등) 를 참조하십시오. ) 데이터 사전에 따라 작성해야 합니다.

2.3.6 프로그램 코드에는 충분한 내결함성 처리 기능이 있어야 합니다.

가능한 예외의 경우 C++ throw 형식 통합 사용:

시도하다

{

//예외를 발생시킬 수 있는 코드

T 를 던지다 //수동으로 예외 발생

}

Catch (type _1e)//type _1은 유형 정의자입니다 (예: int, CException, _ com _ erer)

{

// type_ 1 유형 예외 처리

}

Catch (유형 2 e)

{

// type_2 유형 예외 처리

}

2.3.7 프로그램 코드 구조는 명확하고 빈 행을 적절하게 사용해야 합니다.

2.3.8 항목의 버전 관리는 엄격해야 하며 버전 형식은 me.ae.yy.mmdd 여야 합니다. 여기서 [me] 는 주 버전 번호입니다. [ae] 는 부 버전 번호를 나타냅니다. [yy.mmdd] 는 버전이 작성된 날짜를 나타냅니다. 최신 버전은 가능한 한 이전 버전의 사용, 데이터 또는 프로토콜과 호환됩니다.

2.4 파일 명명 규칙

2.4. 1 시스템 설계에 명시된 구조에 따라 필요에 따라 적절한 폴더와 하위 폴더를 설정합니다.

2.4.2 폴더와 파일의 이름은 가능한 한 의미를 표현하고 영어 이름을 사용해야 하며 한자는 절대 허용되지 않습니다.

2.4.3 파일 이름은 일반적으로 "xxx_yyy.ext" 형식을 사용하며, xxx(3-4 자) 는 분류를 나타내고 yyy (사용자 정의 문자 수) 는 작업 (예: "/example/;

\

나는 회사 서류에서 베꼈다! 너에게 쓸모가 있는지 직접 보아라!