오류 메시지가 얼마나 상세해야합니까?

https://stackoverflow.com/questions/403333

03-07-2019
|

문제

오류 메시지에 대한 일반적인 합의가 무엇인지 궁금했습니다. 그들은 얼마나 상세해야합니까?

나는 너무 큰 숫자를 입력하기위한 다른 오류 메시지가 너무 커서 너무 작고 소수점이 있었고 문자열 등이있는 프로젝트에서 작업했습니다. 그러나 오류 처리 코드는 실제 비즈니스 로직 크기와 경쟁하기 시작했으며 자체 버그 중 일부를 개발하기 시작했습니다.

반대편에서 나는 당신이 다음과 같은 매우 일반적인 오류를 얻는 프로젝트에서 작업했습니다.

실패한 이유 3를 컴파일합니다

말할 필요가없는 것은 이유 3이 링크 오류를 의미하는 것으로 밝혀 졌기 때문에 거의 전혀 쓸모가 없었습니다.

그래서 중간지면은 어디에 있습니까? 충분한 오류 메시지를 추가했는지 어떻게 알 수 있습니까? 사용자가 자신이 잘못된 위치를 이해할 수 있는지 어떻게 알 수 있습니까?

해결책

오류 메시지에 대한 두 가지 대상 청중, 사용자 및 개발자가 있습니다.

일반적으로 메시지가 사용자를 대상으로해야합니다.

o 문제의 원인은 무엇입니까?
o 프로그램이 문제를 해결할 수없는 이유
o 사용자가 문제를 해결하기 위해 할 수있는 일.
o 문제를보고하는 방법.

문제 가보고되면 보고서에는 가능한 많은 프로그램 컨텍스트 정보가 포함되어야합니다.

o 모듈 이름
o 함수 이름
o 라인 번호
o 문제의 일반 영역에 대한 관심 변수
o 핵심 덤프 일 수도 있습니다.

올바른 청중을 목표로합니다.

다른 팁

가능한 한 몇 마디로 무슨 일이 있었는지, 사용자의 옵션이 무엇인지 전달해야합니다. 오류 메시지가 길어질수록 사용자가 읽을 가능성이 줄어 듭니다. 마찬가지로, 짧은 오류 메시지는 비밀스럽고 쓸모가 없습니다. 길이 측면에서 달콤한 지점이 있으며 모든 상황마다 다릅니다.

너무 짧아:

잘못된 입력.

너무 오래:

192.168.0.1과 같은 올바른 형식의 IP 주소를 입력하십시오. IP 주소는 네트워크에서 컴퓨터를 식별하는 데 사용되는 숫자입니다.

바로:

유효한 IP 주소를 입력하십시오.

Code Bloat에 관한 한, 약간의 추가 코드가 사용자가 지원을 호출하거나 좌절하지 못하면 좋은 투자입니다.

오류 메시지에는 두 가지 유형이 있습니다. 사용자가 볼 수있는 오류 메시지와 프로그래머가 볼 수있는 메시지.

"사용자가 자신이 어디에서 잘못되었는지 이해할 수 있는지 어떻게 알 수 있습니까?" 나는 그 메시지가 사용자 에게서만 볼 것이라고 가정하고, 매우 기술적 인 메시지는 아니라고 가정하고 있습니다. COMPILE FAILED REASON 3 일반적인 최종 사용자 오류 메시지가 아닙니다. 프로그래머가 볼 수있는 것입니다 (사용자는 일반적으로 물건을 컴파일하지 않습니다).

따라서 사용자라면 볼 수 있습니다.

짧은 "이것은 오류 메시지입니다"( "Ops! Something Ord Ord Ord Trost!"등을 제공합니다.
오류에 대한 작은 일반적인 설명을 제공합니다 ( "연결하려는 사이트는 사용할 수없는 것 같습니다"/"xyz 작업을 수행 할 권한이 충분하지 않은 것 같습니다"/etc.).
사용자가 세부 정보 (예외 스택 추적, 오류 코드 등)를 포함하여 컴퓨터를 잘 이해하는 경우 "세부 사항 >>"버튼을 추가하십시오.

마지막으로 사용자에게 간단하고 이해할 수있는 명령을 제공합니다 ( "다시 시도", "취소"등).

오류 메시지에 대한 실제 질문은 표시 해야하는 경우입니다. 많은 오류 메시지가 사용자에게 제공되지만 수정할 방법은 없습니다.

오류를 수정할 수있는 방법이있는 한, 오류를 스스로 수정할 수있는 충분한 정보를 사용자에게 제공하십시오. 그들이 스스로 수정할 수 없다면 충돌의 기술적 이유를 그들에게 알릴 이유가 있습니까? 나중에 문제 해결을 위해 파일에 로그인하지 마십시오.

필요한만큼 자세히;)

나는 그것이 똑똑한 엉덩이 대답처럼 들리지만, 이것의 대부분은 대상 고객과 오류 유형에 달려 있습니다. 잘못된 사용자 항목으로 인한 오류의 경우 유효한 항목을 구성하는 항목을 표시 할 수 있습니다. 사용자가 제어 할 수없는 오류의 경우 일반적인 "우리가 작업중인"유형 메시지가 수행 될 수 있습니다.

나는 길이에 대한 Jon B의 의견에도 동의합니다.

오류 메시지는 상세해야하지만 명확해야합니다. 이것은 여러 레벨의 오류 메시지를 결합하여 달성 할 수 있습니다.

Failed to save the image
Permission denied: /foo.jpg

여기에는 두 가지 레벨이 있습니다. 더 많은 것이있을 수 있습니다. 먼저 우리는 큰 그림을 말하고 세부 사항을 말합니다. 이 순서는 먼저 우리가 대부분의 부분을 이해하고 사람들이 이해하는 부분을 이해하는 부분을 가지고 있지만, 둘 다 여전히 볼 수 있습니다.

또한 수정 제안이있을 수 있습니다.

나는 더 자세한 측면에서 잘못을 저지르지 만, 당신이 당신의 질문에 대답했다고 생각합니다. 코드의 팽창을 피하기 위해 코드/오류 메시지에 유용한 정보를 제공하지만 문서에서 또는 도움말 파일 또는 FAQ를 사용하여 자세한 내용을 제공 할 수 있습니다.

내 의견으로는 정보가 너무 적은 것이 더 나쁩니다.

풍부한 내성 또는 기타 기능이있는 언어를 사용하는 경우 수표에 실패한 로그 라인이 유용합니다. 그런 다음 사용자는 기술 지원으로 전달하거나 자세한 정보를 얻을 수 있으며 이는 추가 코드 Bloat가 아니라 자신의 코드를 사용하여 정보를 제공합니다.

라이센스 : CC-BY-SA ~와 함께 속성

제휴하지 않습니다 StackOverflow