기본 와이즈 토토는 짧고 사실이어야하며 특정 함수 이름과 같은 구현 세부 사항에 대한 참조를 피하십시오.“짧은”평균“정상 조건에서 한 줄에 맞아야”. 기본 와이즈 토토를 짧게 유지하기 위해 필요한 경우 세부 와이즈 토토를 사용하거나 실패한 특정 시스템 호출과 같은 구현 세부 사항을 언급해야한다고 생각하십시오. 기본 및 세부 와이즈 토토는 모두 사실이어야합니다. 특히 제안이 항상 적용되지 않는 경우 문제를 해결하기 위해해야 ​​할 일에 대한 제안을 위해 힌트 와이즈 토토를 사용하십시오.

예를 들어 : 대신 :

ipcmemorycreate : shmget (key =%d, size =%u, 0%o) 실패 :%m
(기본적으로 힌트 인 긴 부록도

쓰기 :

기본 : 공유 메모리 세그먼트를 생성 할 수 없습니다 : %m
세부 사항 : 실패한 syscall은 shmget (key =%d, size =%u, 0%o)입니다.
힌트 : 완전한 문장으로 작성된 부록.

Rationale : 기본 와이즈 토토를 짧게 유지하면 한 줄이 오류 와이즈 토토에 충분하다는 가정에서 클라이언트가 화면 공간을 배치 할 수 있도록합니다. 세부 사항 및 힌트 와이즈 토토는 장점 모드 또는 팝업 오류 사정 창으로 강등 될 수 있습니다. 또한 세부 사항과 힌트는 일반적으로 서버 로그에서 공간을 절약하기 위해 억제됩니다. 구현 세부 사항에 대한 참조는 사용자가 세부 사항을 알지 못하기 때문에 피하는 것이 가장 좋습니다.

메시지 텍스트에 서식에 대한 구체적인 가정을하지 마십시오. 클라이언트와 서버 로그가 자신의 요구에 맞게 줄을 랩핑 할 것으로 예상합니다. 긴 메시지에서 Newline 문자 (\ n)를 사용하여 제안 된 단락 브레이크를 표시 할 수 있습니다. Newline으로 메시지를 끝내지 마십시오. 탭이나 다른 형식 문자를 사용하지 마십시오. (오류 컨텍스트 표시에서는 Newlines가 기능 호출과 같은 별도의 컨텍스트에 자동으로 추가됩니다.)

이론적 : 와이즈 토토가 터미널 유형 디스플레이에 반드시 표시되는 것은 아닙니다. GUI 디스플레이 또는 브라우저에서 이러한 형식 지침은 기껏해야 무시됩니다.

영어 텍스트는 인용이 적절할 때 이중 인용문을 사용해야합니다. 다른 언어로 된 텍스트는 다른 프로그램의 관습 및 컴퓨터 출력과 일치하는 한 종류의 인용문을 지속적으로 사용해야합니다.

근거 : 단일 따옴표를 통해 이중 인용문을 선택하는 것은 다소 임의적이지만 선호하는 사용 경향이 있습니다. 일부는 SQL 컨벤션에 따른 객체 유형에 따라 인용문의 종류를 선택할 것을 제안했습니다 (즉, 문자열 단일 인용, 식별자는 이중 인용). 그러나 이것은 많은 사용자가 익숙하지 않은 언어 내부 기술 문제입니다. 그것은 다른 종류의 인용 용어로 확장되지 않으며 다른 언어로 번역되지 않으며 꽤 무의미합니다..

항상 따옴표를 사용하여 파일 이름, 사용자 지원 식별자, 구성 변수 이름 및 단어를 포함 할 수있는 기타 변수를 구분합니다. 단어를 포함하지 않는 변수 (예 : 연산자 이름)를 표시하는 데 사용하지 마십시오.

백엔드에는 필요에 따라 자체 출력을 두 배로 늘리는 기능이 있습니다 (예 :format_type_be ()). 그러한 기능의 출력에 대한 추가 인용문을 넣지 마십시오.

이론적 : 객체는 와이즈 토토에 포함될 때 모호성을 생성하는 이름을 가질 수 있습니다. 플러그인 이름이 시작되고 끝나는 위치를 나타내는 것에 대해 일관성을 유지하십시오. 그러나 불필요하거나 중복 인용 표시로 와이즈 토토를 혼란스럽게하지 마십시오.

규칙은 기본 오류 와이즈 토토와 세부 사항/힌트 와이즈 토토에 대해 다릅니다 :

기본 오류 와이즈 토토 : 첫 번째 문자를 대문자로하지 마십시오. 기간으로 와이즈 토토를 끝내지 마십시오. 느낌표가있는 와이즈 토토를 끝내는 것에 대해 생각조차하지 마십시오.

세부 사항 및 힌트 와이즈 토토 : 전체 문장을 사용하고 각각의 기간으로 종료하십시오. 첫 번째 문장을 활용하십시오. 다른 문장이 뒤 따르는 경우 (영어 텍스트의 경우; 다른 언어에서 부적절 할 수 있음).

오류 컨텍스트 문자열 : 첫 번째 글자를 대문자를 대문자로 만들지 말고 기간으로 문자열을 끝내지 마십시오. 컨텍스트 문자열은 일반적으로 완전한 문장이되어서는 안됩니다.

이론적 근거 : 구두점을 피하면 클라이언트 응용 프로그램이 와이즈 토토를 다양한 문법적 맥락에 쉽게 포함시킬 수 있습니다. 종종 기본 와이즈 토토는 어쨌든 문법적으로 완전한 문장이 아닙니다. (그리고 그들이 하나 이상의 문장이 될 정도로 길다면, 기본 및 세부 부분으로 나누어야합니다.) 그러나 세부 사항과 힌트 와이즈 토토는 길고 여러 문장을 포함해야 할 수도 있습니다. 일관성을 위해, 문장이 하나만 있더라도 완전한 문장 스타일을 따라야합니다.

기본 오류 와이즈 토토의 첫 글자를 포함하여 와이즈 토토 문구에 소문자를 사용하십시오. 와이즈 토토에 표시되는 경우 SQL 명령 및 키워드에 대문자를 사용하십시오.

이론적 : 일부 와이즈 토토는 완전한 문장이기 때문에 모든 것이 더 일관되게 보이게하는 것이 더 쉽습니다..

활성 음성 사용. 연기 주제가있을 때 완전한 문장을 사용하십시오 (“a는 할 수 없다 b”). 주제가 프로그램 자체가 될 경우 주제없이 Telegram 스타일을 사용하십시오. 사용하지 마십시오“i”프로그램의 경우.

이론적 : 프로그램은 인간이 아닙니다. 그렇지 않으면 척하지 마십시오.

무언가를 시도한 경우 과거 시제를 사용하지만 다음 번에 성공할 수 있습니다 (아마도 문제를 해결 한 후). 실패가 확실히 영구적 인 경우 현재 시제를 사용하십시오.

형식의 문장 간에는 사소한 의미 론적 차이가 있습니다.

파일을 열 수 없음 " %s": %m

and :

파일을 열 수 없음 "%s"

첫 번째는 파일을 열려는 시도가 실패했음을 의미합니다. 와이즈 토토는와 같은 이유를 제시해야합니다.“디스크 풀”또는“파일이 존재하지 않습니다”. 다음에 디스크가 더 이상 가득 차 있지 않거나 해당 파일이 존재할 수 있기 때문에 과거 시제는 적절합니다.

두 번째 양식은 프로그램에 명시된 파일을 열는 기능이 전혀 존재하지 않거나 개념적으로 불가능하다는 것을 나타냅니다. 현재 시제는 조건이 무기한 지속되기 때문에 적절합니다.

이론적 근거 : 부여 된, 평균 사용자는 단순히 메시지의 긴장에서 단순히 큰 결론을 도출 할 수 없지만 언어는 문법을 제공하기 때문에 우리는 그것을 올바르게 사용해야합니다..

객체의 이름을 인용 할 때 어떤 종류의 개체인지 설명하십시오.

이론적 근거 : 그렇지 않으면 아무도 무엇을 알지 못할 것입니다“foo.bar.baz”참조.

사각형 브래킷 만 (1) 명령 시놉시스에서 선택된 인수를 나타내거나 (2) 배열 위시를 나타 내기 위해 사용됩니다..

근거 : 기타 모든 것은 널리 알려진 관습 사용에 해당하지 않으며 사람들을 혼란스럽게 할 것입니다.

와이즈 토토에 다른 곳에서 생성되는 텍스트가 포함되면이 스타일로 포함시킵니다.

파일을 열 수 없음 %s : %m

근거 :이를 단일 부드러운 문장에 붙여 넣기 위해 가능한 모든 오류 코드를 설명하기가 어려울 것이므로 일부 구두점이 필요합니다. 내장 된 텍스트를 괄호 안에 넣는 것도 제안되었지만, 임베디드 텍스트가 와이즈 토토의 가장 중요한 부분 일 가능성이있는 경우에는 부자연 스럽습니다..

와이즈 토토는 항상 오류가 발생한 이유를 명시해야합니다. 예를 들어:

BAD : 파일을 열 수 없습니다
더 나은 : 파일을 열 수 없음 %s (I/O 실패)

이유가 없으면 코드를 더 잘 수정하십시오.

오류 텍스트에보고 루틴의 이름을 포함하지 마십시오. 필요할 때이를 찾기위한 다른 메커니즘이 있으며 대부분의 사용자에게는 도움이되지 않습니다. 오류 텍스트가 함수 이름 없이는 이해가되지 않으면 다시 표시하십시오.

bad : pg_strtoint32 : "z"의 오류 : "z"를 구문 분석 할 수 없습니다.
더 나은 : Type Integer의 유효하지 않은 입력 구문 : "Z"

불리는 함수 이름을 언급하지 마십시오. 대신 코드가 무엇을하려고했는지 말하십시오 :

나쁜 : Open () 실패 : %m
더 나은 : 파일을 열 수 없음 %s : %m

실제로 필요한 것처럼 보이면 세부 와이즈 토토에 시스템 호출을 언급하십시오. (경우에 따라 시스템 호출에 전달 된 실제 값을 제공하는 것은 세부 와이즈 토토에 적합한 정보 일 수 있습니다.)

근거 : 사용자는 모든 기능이 무엇을하는지 모릅니다.

불가능합니다.  “실수”거의 수동적 인 목소리입니다. 더 나은 사용“할 수 없음”또는“할 수 없음”, 적절하게.

나쁜. 오류 와이즈 토토와 같은“나쁜 결과”지능적으로 해석하기가 어렵습니다. 결과가 왜를 작성하는 것이 좋습니다.“나쁜”, 예 :“잘못된 형식”.

불법.  “불법”법 위반을 의미하고 나머지는입니다.“Invalid”. 더 나은 방법은 왜 유효하지 않은지 말하십시오.

알 수없는. 피하려고“알 수없는”. 고려하다“오류 : 알 수없는 응답”. 당신이 응답이 무엇인지 모른다면, 그것이 잘못된 것을 어떻게 알 수 있습니까?“인식되지 않은”종종 더 나은 선택입니다. 또한 불만받는 값을 포함시켜야합니다.

나쁜 : 알 수없는 노드 유형
더 나은 : 인식되지 않은 노드 유형 : 42

찾기 대 존재. 프로그램이 사소한 알고리즘을 사용하여 리소스 (예 : 경로 검색)를 찾고 알고리즘이 실패하면 프로그램이 할 수 없다고 말하는 것이 공정합니다.“찾기”자원. 반면에, 자원의 예상되는 위치가 알려져 있지만 프로그램이 그곳에 액세스 할 수 없다면 리소스가 그렇지 않다고 말하면“존재”. 사용“찾기”이 경우 약한 소리와 문제를 혼란스럽게합니다.

May vs. Can vs. May.  “May”권한을 제안합니다 (예 : "내 레이크를 빌릴 수 있습니다.") 문서 또는 오류 메시지에는 거의 사용되지 않습니다.“can”능력을 제안합니다 (예 : "그 로그를 들어 올릴 수 있습니다.") 및.“may”가능성을 제안합니다 (예 : "오늘 비가 올 수 있습니다."). 적절한 단어를 사용하여 의미를 명확하게하고 번역을 지원합니다.

수축. 수축을 피하십시오“할 수 없습니다”; 사용“할 수 없음”대신.

비 음성. 피하기“비 음성”그것이 0을 받아들이는지에 대해 모호합니다. 사용하는 것이 좋습니다“0보다 큰”또는“0보다 크거나 동일합니다”.

단어를 전체적으로 철자하십시오. 예를 들어, 피하기 :

근거 : 이것은 일관성을 향상시킬 것입니다.

오류 와이즈 토토 텍스트는 다른 언어로 변환되어야합니다. 에서 가이드 라인을 따르십시오.섹션 55.2.2번역기의 삶을 어렵게 만드는 것을 피하려면