이 문서는 지원되지 않는 토토 사이트 순위 버전에 대한 것입니다.
당신은 다음과 같은 페이지를 보고 싶을 수도 있습니다.범퍼카 토토 : 문서 : 17 : J.6. 스타일 가이드버전 또는 위에 나열된 다른 지원 버전 중 하나를 사용하세요.

J.5. 스타일 가이드

J.5.1. 참조 페이지

참조 페이지는 표준 레이아웃을 따라야 합니다. 이를 통해 사용자가 원하는 정보를 더욱 빠르게 찾을 수 있으며, 작성자가 명령의 모든 관련 측면을 문서화하도록 권장합니다. 일관성은 다음 사이에서만 요구되는 것이 아닙니다.포스트그레SQL참조 페이지뿐만 아니라 운영 체제 및 기타에서 제공하는 참조 페이지 패키지. 따라서 다음과 같은 지침이 개발되었습니다. 그들 대부분 유사한 지침과 일치합니다. 다양한 운영 체제에 의해 설정됩니다.

실행 가능한 명령을 설명하는 참조 페이지에는 다음이 포함되어야 합니다. 다음 섹션을 이 순서대로 진행하세요. 해당되지 않는 섹션 생략 가능합니다. 추가 최상위 섹션만 사용해야 합니다. 특별한 상황에서; 종종 해당 정보는"사용법"섹션.

이름

이 섹션은 자동으로 생성됩니다. 여기에는 명령이 포함되어 있습니다. 이름과 기능에 대한 반문장 요약입니다.

시놉시스

이 섹션에는 명령의 구문 다이어그램이 포함되어 있습니다. 그만큼 개요는 일반적으로 각 명령줄 옵션을 나열하지 않아야 합니다. 즉 아래에서 완료되었습니다. 대신 명령줄의 주요 구성 요소를 나열하세요. 입력 및 출력 파일이 어디로 가는지 등.

설명

명령어의 기능을 설명하는 여러 단락.

옵션

각 명령줄 옵션을 설명하는 목록입니다. 많은 경우 옵션 중 하위 섹션을 사용할 수 있습니다.

종료 상태

프로그램이 성공을 위해 0을 사용하고 실패를 위해 0이 아닌 값을 사용한다면, 문서화할 필요는 없습니다. 뒤에 숨은 뜻이 있다면 0이 아닌 다른 종료 코드는 여기에 나열하세요.

사용법

프로그램의 하위 언어 또는 런타임 인터페이스를 설명하십시오. 프로그램이 대화형이 아닌 경우 일반적으로 이 섹션은 생략. 그렇지 않은 경우 이 섹션은 설명을 위한 포괄적인 내용입니다. 런타임 기능. 해당하는 경우 하위 섹션을 사용하세요.

환경

프로그램이 사용할 수 있는 모든 환경 변수를 나열합니다. 노력하다 완전하다; 심지어는 겉보기에 사소해 보이는 변수도사용자가 관심을 가질 수 있습니다.

파일

프로그램이 암시적으로 접근할 수 있는 모든 파일을 나열합니다. 저것 즉, 지정된 입력 및 출력 파일을 나열하지 않습니다. 명령줄이지만 구성 파일 등을 나열합니다.

진단

프로그램이 생성할 수 있는 비정상적인 출력을 설명하십시오. 가능한 모든 오류 메시지를 나열하지 마십시오. 이것은 많은 작동하며 실제로는 거의 사용되지 않습니다. 하지만 예를 들어 오류가 발생하면 메시지에는 사용자가 구문 분석할 수 있는 표준 형식이 있습니다. 설명할 수 있는 자리가 되어주세요.

참고

다른 곳에 맞지 않는 모든 것, 특히 버그는 구현 결함, 보안 고려 사항, 호환성 문제.

역사

만약 역사에 몇 가지 중요한 이정표가 있었다면 프로그램의 경우 여기에 나열될 수 있습니다. 일반적으로 이 섹션은 생략했습니다.

저자

저자 (기고 섹션에서만 사용됨)

또한 참조

상호 참조, 다음 순서로 나열됨: 기타토토 사이트 순위명령 참조 페이지,토토 사이트 순위SQL 명령 참조 페이지, 인용토토 사이트 순위설명서, 기타 참조 페이지 (예: 운영 체제, 기타 패키지), 기타 문서. 같은 그룹에 있는 항목은 알파벳순으로 나열됩니다.

SQL 명령을 설명하는 참조 페이지에는 다음이 포함되어야 합니다. 다음 섹션: 이름, 개요, 설명, 매개변수, 출력, 참고, 예, 호환성, 기록, 참조. 그만큼 매개변수 섹션은 옵션 섹션과 비슷하지만 더 많은 기능이 있습니다. 명령의 어떤 절을 나열할 수 있는지는 자유입니다. 그만큼 출력 섹션은 명령이 무언가를 반환하는 경우에만 필요합니다. 기본 명령 완료 태그가 아닌 경우. 호환성 섹션에서는 이 명령이 어느 정도까지 준수되는지 설명해야 합니다. SQL 표준 또는 다른 데이터베이스 시스템에 적용됨 호환 가능. SQL 명령의 참고 항목 섹션에는 SQL이 나열되어야 합니다. 프로그램을 상호 참조하기 전에 명령을 사용합니다.