토토 사이트 순위 9.3.25 문서화 | ||||
---|---|---|---|---|
PostgreSQL: Tài 범퍼카 토토u: 9.3: Tài 범퍼카 토토u tác 범퍼카 토토ả | 스포츠 토토 베트맨 : 문서 : 9.3 : 문서화 | 부록 J. 선적 서류 비치 | 토토 캔 : 문서 : 9.3 : 토토 캔 |
참조 페이지는 표준 레이아웃을 따라야합니다. 이것은 허용합니다 사용자는 원하는 정보를 더 빨리 찾을 수 있으며 작가가 명령의 모든 관련 측면을 문서화하도록 권장합니다. 일관성은 |토토 사이트 순위참조 페이지와 함께 운영 체제 및 기타에서 제공하는 참조 페이지 패키지. 따라서 다음 지침이 개발되었습니다. 그들 대부분 비슷한 지침과 일치합니다 다양한 운영 체제에 의해 설립되었습니다.
실행 가능한 명령을 설명하는 참조 페이지에는 포함되어야합니다 이 순서로 다음 섹션. 적용되지 않는 섹션 생략 할 수 있습니다. 추가 최상위 섹션 만 사용해야합니다 특별한 상황에서; 종종 그 정보는에 속합니다."사용"섹션.
이 섹션은 자동으로 생성됩니다. 명령이 포함되어 있습니다 기능의 이름과 반 중앙 요약.
이 섹션에는 명령의 구문 다이어그램이 포함되어 있습니다. 그만큼 시놉시스는 일반적으로 각 명령 줄 옵션을 나열해서는 안됩니다. 그게 아래에서 완료되었습니다. 대신 명령 줄의 주요 구성 요소를 나열하고 입력 및 출력 파일의 위치와 같은.
명령이 무엇을하는지 설명하는 여러 단락.
각 명령 줄 옵션을 설명하는 목록. 많은 경우 옵션, 하위 섹션을 사용할 수 있습니다.
프로그램이 성공을 위해 0을 사용하고 실패로 0이 아닌 경우 문서화 할 필요가 없습니다. 뒤에 의미가 있다면 0이 아닌 출구 코드, 여기에 나열하십시오.
프로그램의 호화로운 또는 런타임 인터페이스를 설명하십시오. 프로그램이 대화식이 아닌 경우이 섹션은 일반적으로 생략. 그렇지 않으면,이 섹션은 설명하기위한 포괄적입니다 런타임 기능. 적절한 경우 하위 섹션을 사용하십시오.
프로그램이 사용할 수있는 모든 환경 변수를 나열하십시오. 노력하다 완료되기 위해; 겉보기에는조차도쉘사용자에게 관심이있을 수 있습니다.
프로그램이 암시 적으로 액세스 할 수있는 파일을 나열합니다. 저것 IS, 지정된 입력 및 출력 파일을 나열하지 마십시오. 명령 줄이지만 구성 파일 등을 나열합니다.
프로그램이 만들 수있는 비정상적인 출력을 설명하십시오. 가능한 모든 오류 메시지를 나열하지 마십시오. 이것은 많은 것입니다 일하고 실제로 사용하지 않습니다. 그러나 예를 들어 오류가 있다면 메시지는 사용자가 구문 분석 할 수있는 표준 형식이 있습니다. 설명 할 곳이 되십시오.
다른 곳에 맞지 않지만 특히 버그, 구현 결함, 보안 고려 사항, 호환성 문제.
예
프로그램, 여기에 나열 될 수 있습니다. 일반적 으로이 섹션은 될 수 있습니다 생략.
저자 (Contrib Section에서만 사용)
다음 순서로 나열된 상호 참조 : 기타토토 사이트 순위명령 참조 페이지,토토 사이트 순위SQL 명령 참조 페이지, 인용토토 사이트 순위매뉴얼, 기타 참조 페이지 (예 : 운영 체제, 기타 패키지), 기타 문서. 같은 그룹의 항목은 알파벳순으로 나열됩니다.
SQL 명령을 설명하는 참조 페이지에는 다음 섹션 : 이름, 시놉시스, 설명, 매개 변수, 출력, 메모, 예제, 호환성, 역사도 참조하십시오. 그만큼 매개 변수 섹션은 옵션 섹션과 같지만 더 명령의 어떤 조항이 나열 될 수 있는지에 대한 자유. 그만큼 출력 섹션은 명령이 무언가를 반환하는 경우에만 필요합니다. 기본 명령-완성 태그 외에. 호환성 섹션은이 명령이 어느 정도 일치하는지를 설명해야합니다. SQL 표준 또는 기타 데이터베이스 시스템 호환 가능. SQL 명령의 섹션도 SQL을 나열해야합니다. 프로그램에 대한 상호 참조 전 명령.