J.6. 스타일 가이드#

J.6.1. 참조 토토 꽁 머니#

참조 토토 꽁 머니는 표준 레이아웃을 따라야합니다. 이를 통해 사용자는 원하는 정보를 더 빨리 찾을 수 있으며, 작가는 또한 명령의 모든 관련 측면을 문서화하도록 권장합니다.PostgreSQL참조 페이지뿐만 아니라 운영 체제 및 기타 패키지에서 제공하는 참조 페이지도 있습니다. 따라서 다음 지침이 개발되었습니다.

실행 가능한 명령을 설명하는 참조 페이지에는 다음 섹션이 포함되어야합니다. 적용되지 않는 섹션은 생략 할 수 있습니다.usage섹션.

이름 #

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

시놉시스 #

이 섹션에는 명령의 구문 다이어그램이 포함되어 있습니다. 시놉시스는 일반적으로 각 명령 줄 옵션을 나열해서는 안됩니다.

설명 #

명령이 무엇을하는지 설명하는 여러 단락.

옵션 #

각 명령 줄 옵션을 설명하는 목록. 옵션이 많으면 하위 섹션을 사용할 수 있습니다.

종료 상태 #

프로그램이 성공을 위해 0을 사용하고 실패에 대해 0이 아닌 경우 문서화 할 필요가 없습니다. 0이 아닌 출구 코드 뒤에 의미가있는 경우 여기에 나열하십시오.

usage #

프로그램의 호화로운 또는 런타임 인터페이스를 설명하십시오. 프로그램이 대화식이 아닌 경우이 섹션을 일반적으로 생략 할 수 있습니다.

환경 #

프로그램이 사용할 수있는 모든 환경 변수를 나열하십시오. 완전하게 노력하십시오.사용자에게 관심이있을 수 있습니다.

파일 #

프로그램이 암시 적으로 액세스 할 수있는 파일을 나열합니다. 즉, 명령 줄에 지정된 입력 및 출력 파일을 나열하지 말고 구성 파일 등을 나열하십시오.

진단 #

프로그램이 만들 수있는 비정상적인 출력을 설명하십시오. 가능한 모든 오류 메시지를 나열하지 마십시오.

노트 #

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

예제 #

예제

역사 #

프로그램 역사에 몇 가지 주요 이정표가 있다면 여기에 나열 될 수 있습니다. 일반적 으로이 섹션을 생략 할 수 있습니다.

저자 #

저자 (Contrib 섹션에서만 사용)

참조 #

다음 순서로 나열된 상호 참조 : 기타PostgreSQL명령 참조 페이지,PostgreSQLSQL 명령 참조 페이지, 인용PostgreSQL매뉴얼, 기타 참조 페이지 (예 : 운영 체제, 기타 패키지), 기타 문서. 같은 그룹의 항목은 알파벳순으로 나열됩니다.

SQL 명령을 설명하는 참조 페이지에는 다음 섹션이 포함되어야합니다. 이름, 시놉시스, 설명, 매개 변수, 출력, 메모, 예제, 호환성, 기록, 참조도 참조하십시오. 매개 변수 섹션은 옵션 섹션과 비슷하지만 명령의 조항을 나열 할 수있는 더 많은 자유가 있습니다.

정정 제출

문서에 올바르지 않은 내용이 있으면 일치하지 않습니다.이 양식문서 문제를보고하려면