| PostgreSQL 8.1.23 문서 | ||||
|---|---|---|---|---|
| 이전 | 빠른 뒤로 | 44 장. PostgreSQL 코딩 규칙 | 빠른 전달 | 젠 토토stgreSQL : 문서 : 8.1 : 모국어 지원 |
이 스타일 가이드는 모든 와이즈 토토에서 일관되고 사용자 친화적 인 스타일 생성PostgreSQL.
기본 와이즈 토토는 짧고 사실적이며 피해야합니다 특정 기능과 같은 구현 세부 사항에 대한 참조 이름."짧은"수단"는 정상 아래 한 줄에 맞아야합니다 정황". 필요한 경우 세부 와이즈 토토를 사용하십시오 기본 와이즈 토토가 짧거나 언급 할 필요가 있다고 생각하는 경우 특정 시스템과 같은 구현 세부 사항을 호출하십시오 실패한. 기본 및 세부 와이즈 토토는 모두 사실이어야합니다. 사용 수정하기 위해해야 할 일에 대한 제안에 대한 힌트 와이즈 토토 문제, 특히 제안이 항상 있지 않을 경우 해당되는.
예를 들어, 대신
ipcmemorycreate : shmget (key =%d, size =%u, 0%o) 실패 :%m (기본적으로 힌트 인 긴 부록도
쓰기
기본 : 공유 메모리 세그먼트를 생성 할 수 없습니다 : %m 세부 사항 : 실패한 syscall은 shmget (key =%d, size =%u, 0%o)입니다. 힌트 : 부록
근거 : 기본 와이즈 토토를 짧게 유지하면 유지하는 데 도움이됩니다 시점까지 클라이언트가 화면 공간을 배치 할 수 있도록 한 줄이 오류 와이즈 토토에 충분하다고 가정합니다. 세부 사항 힌트 와이즈 토토 아마도 팝업 오류 사정 창이 될 수 있습니다. 또한 세부 사항 및 힌트 일반적으로 서버 로그에서 공간을 절약하기 위해 억제됩니다. 구현 세부 사항에 대한 참조는 사용자이므로 피하는 것이 가장 좋습니다 어쨌든 세부 사항을 모릅니다.
서식에 대한 구체적인 가정을하지 마십시오 와이즈 토토 텍스트. 클라이언트와 서버 로그가 줄을 랩핑 할 것으로 예상합니다 자신의 요구에 맞게. 긴 와이즈 토토, Newline 캐릭터 (\ n) 제안 된 단락 브레이크를 나타내는 데 사용될 수 있습니다. 하지 않다 Newline으로 와이즈 토토를 종료하십시오. 탭이나 기타를 사용하지 마십시오 문자 포맷. (오류 컨텍스트 표시에서는 Newlines입니다 다음과 같은 별도의 컨텍스트에 자동으로 추가됩니다 기능 호출.)
근거 : 와이즈 토토가 반드시 표시되지는 않습니다 터미널 형 디스플레이. GUI에서는 이들을 표시하거나 브라우저로 표시합니다 서식 지침은 기껏해야 무시됩니다.
영어 텍스트는 인용 할 때 이중 인용문을 사용해야합니다 적절한. 다른 언어로 된 텍스트는 지속적으로 사용해야합니다 출판 세관과 일치하는 한 종류의 인용문 그리고 다른 프로그램의 컴퓨터 출력.
이론적 : 단일 따옴표를 통해 이중 인용문의 선택은 다음과 같습니다. 다소 임의적이지만 선호하는 사용 경향이 있습니다. 일부 에 따라 인용문의 종류를 선택할 것을 제안했습니다. SQL 규칙에 따른 객체의 유형 (즉, 문자열 단일 견적, 식별자 이중 인용). 그러나 이것은 A입니다 많은 사용자가 아닌 언어 내부 기술 문제 익숙해지면 다른 종류의 인용 용어로 확장되지 않으며 그것은 다른 언어로 번역되지 않으며 예쁘다 무의미합니다.
항상 인용문을 사용하여 파일 이름, 사용자 공급 식별자 및 단어가 포함될 수있는 기타 변수. 하다 단어를 포함하지 않는 변수를 표시하는 데 사용하지 마십시오. (예 : 운영자 이름).
백엔드에는 이중 쿼트 기능이 있습니다
필요에 따른 자신의 출력 (예 :format_type_be()). 추가하지 마십시오
그러한 함수의 출력에 대한 인용문.
이론적 : 객체는 모호성을 생성하는 이름을 가질 수 있습니다 와이즈 토토에 포함됩니다. 위치를 나타내는 것에 대해 일관성을 유지하십시오 플러그인 이름이 시작되고 끝납니다. 그러나 와이즈 토토를 혼란스럽게하지 마십시오 불필요하거나 중복 인용 표시가 있습니다.
기본 오류 와이즈 토토에 대해 규칙이 다릅니다. 세부 사항/힌트 와이즈 토토 :
기본 오류 와이즈 토토 : 첫 번째 문자를 대문자로하지 마십시오. 기간으로 와이즈 토토를 끝내지 마십시오. 생각조차하지 마십시오 느낌표가있는 와이즈 토토 종료.
세부 사항 및 힌트 와이즈 토토 : 완전한 문장을 사용하고 끝을 사용하십시오 각각의 기간이 있습니다. 첫 번째 문장을 대문자로 삼으십시오.
이론적 근거 : 구두점을 피하면 클라이언트가 더 쉬워집니다 와이즈 토토를 다양한 문법에 포함시키는 응용 프로그램 맥락. 종종 기본 와이즈 토토는 문법적으로는 아닙니다 어쨌든 완전한 문장. (그리고 그들이 충분히 길면 하나 이상의 문장, 그들은 1 차로 나누고 세부 부품.) 그러나 세부 사항과 힌트 와이즈 토토는 더 길고 여러 문장을 포함해야 할 수도 있습니다. 일관성을 위해 만있을 때에도 완전한 문장 스타일을 따라야합니다 한 문장.
첫 번째를 포함하여 와이즈 토토 문구에 소문자를 사용하십시오 기본 오류 와이즈 토토의 문자. SQL에는 대문자를 사용하십시오 와이즈 토토에 표시되면 명령 및 키워드.
이론적 : 모든 것을 더 잘 보이게하는 것이 더 쉽습니다 일부 와이즈 토토는 완전한 문장이기 때문에 일관성이 있습니다 그리고 일부는 아닙니다.
활성 음성을 사용하십시오. 있을 때 완전한 문장을 사용하십시오 연기 주제 ("a는 할 수 없습니다 비"). 피사체가 주제없이 텔레 그램 스타일을 사용하십시오 프로그램 자체가 될 것입니다. 사용하지 마십시오"I"프로그램의 경우
근거 : 프로그램은 인간이 아닙니다. 척하지 마십시오 그렇지 않으면.
무언가를 시도하지 않으면 과거 시제를 사용하지만 다음 번에 성공할 수 있습니다 (아마도 일부 수정 후 문제). 실패가 확실한 경우 현재 시제를 사용하십시오 영구적인.
문장 사이에는 사소한 의미 론적 차이가 있습니다 양식의
파일을 열 수 없음 " %s": %m
and
파일을 열 수 없음 "%s"
첫 번째는 파일을 열려고 시도하는 것을 의미합니다. 실패한. 와이즈 토토는와 같은 이유를 제시해야합니다."디스크 풀"또는"파일은 그렇지 않습니다 존재하다". 과거 시제는 다음에 적합합니다 디스크가 더 이상 가득 차 있지 않을 수도 있고 문제의 파일이 5 월 존재하다.
두 번째 양식은 개방 기능을 나타냅니다 명명 된 파일은 프로그램에 전혀 존재하지 않거나 개념적으로 불가능합니다. 현재 시제는 적절합니다 상태는 무기한 지속되기 때문에.
근거 : 부여 된, 평균 사용자는 단지 와이즈 토토의 시제에서 큰 결론을 내립니다. 그러나 언어는 우리가 사용해야하는 문법을 제공하기 때문에 정확하게.
사각형 브래킷 만 사용하기 만하면 (1) 명령 시놉시스에서 선택적 인수를 나타내거나 (2) 배열을 표시하려면 첨자.
이론적 : 기타는 널리 알려진 것에 해당하지 않습니다 관습적인 사용 및 사람들을 혼동 할 것입니다.
와이즈 토토에 다른 곳에서 생성되는 텍스트가 포함되면 이 스타일로 포함하십시오 :
파일을 열 수 없음 %s : %m
근거 : 가능한 모든 것을 설명하기가 어려울 것입니다. 이것을 단일 부드러운 문장에 붙여 넣는 오류 코드. 어떤 종류의 구두점이 필요합니다. 임베디드 텍스트를 넣습니다 괄호 안에서도 제안되었지만 불충분합니다. 임베디드 텍스트가 가장 중요한 부분 일 가능성이 높습니다. 종종 그렇듯이 와이즈 토토.
와이즈 토토는 항상 오류 이유를 명시해야합니다 발생했습니다. 예를 들어:
BAD : 파일을 열 수 없습니다. %s 더 나은 : 파일을 열 수 없음 %s (I/O 실패)
이유가 없으면 코드를 더 잘 수정하십시오.
오류에보고 루틴의 이름을 포함하지 마십시오. 텍스트. 우리는 그것을 찾을 때 다른 메커니즘을 가지고 있습니다 필요하고 대부분의 사용자에게는 도움이되지 않습니다. 만약 오류 텍스트는 함수 없이는 이해가되지 않습니다. 이름, reword.
bad : pg_atoi : "z"의 오류 : "z"를 구문 분석 할 수 없습니다. 더 나은 : 정수의 유효하지 않은 입력 구문 : "Z"
함수 이름을 언급하지 마십시오. 대신 말하십시오 코드가하려는 일 :
bad : Open () 실패 : %m 더 나은 : 파일을 열 수 없음 %s : %m
실제로 필요한 것처럼 보이면 시스템 호출을 언급하십시오. 세부 와이즈 토토. (경우에 따라 실제 값을 제공합니다 시스템 호출에 전달 된 것은 적절한 정보 일 수 있습니다. 세부 와이즈 토토.)
근거 : 사용자는 모든 기능이 무엇을하는지 모릅니다.
불가능한. "Unable"IS 거의 수동적 인 목소리. 더 나은 사용"할 수 없음"또는"할 수 있습니다 아니다", 적절하게.
나쁜.오류 와이즈 토토와 같은"나쁜 결과"지능적으로 해석하기가 어렵습니다. 결과가 왜를 작성하는 것이 좋습니다."나쁜", 예 :"잘못된 체재".
불법. "불법"법을 위반하는 것을 의미하고 나머지는입니다."무효". 더 나은 아직, 왜 그런지 말하십시오 유효하지 않은.
알 수없는.피하려고"알 수없는". 고려하다"오류 : 알 수없는 응답". 모른다면 응답은 무엇인가, 그것이 잘못되었다는 것을 어떻게 알 수 있습니까?"인식되지 않은"종종 더 좋습니다 선택. 또한 불만받는 값을 포함시켜야합니다 의.
나쁜 : 알 수없는 노드 유형 더 나은 : 인식되지 않은 노드 유형 : 42
찾기 대 존재.프로그램이 사소한 것을 사용하는 경우 리소스 (예 : 경로 검색)를 찾는 알고리즘 및 알고리즘이 실패합니다. 프로그램이 할 수 없다고 말하는 것이 공정합니다."찾기"자원. 만약 다른 한편으로, 자원의 예상 위치는 알려져 있습니다. 그러나이 프로그램은 그곳에서 접근 할 수 없습니다. 리소스는"ENDIST". 사용"찾기"이 경우 약해집니다 그리고 문제를 혼란스럽게합니다.
오류 와이즈 토토 텍스트를 번역해야한다는 점을 명심하십시오. 다른 언어로. 에서 가이드 라인을 따르십시오.섹션 45.2.2to 번역가에게는 삶을 어렵게 만드는 것을 피하십시오.
| 이전 | 홈 | 젠 토토stgreSQL : 문서 : 8.1 : 모국어 지원 |
| 보고 오류 서버 내에서 | up | 모국어 지원하다 |