마침표로 예외 메시지를 종료합니까?
마침표가 있거나없는 예외 메시지를 모두 보았습니다. 그리고 나는 왜 둘 다 좋을 수 있는지에 대한 몇 가지 이유를 생각할 수 있습니다.
- 어떤 점도 마침표를 추가하거나 원할 경우 생략 할 자유를주지 않습니다. 메시지가 어떤 종류의 제목 표시 줄에 들어가는 경우 유용 할 수 있습니다.
- 점이 있으면 "완전한 문장"이 있다는 것을 항상 알 수 있으며 더 완성 된 것처럼 보입니다.
어느 것을 추천합니까?
현지화 된 리소스 문자열에서도 문제가 될 수 있습니다. 분명히 모든 뒤에 마침표를 넣을 수는 없습니다 (버튼과 메뉴 항목 등의 텍스트 뒤에 마침표가 있으면 이상하게 보일 것입니다). 그러나 일관성을 유지하기 위해 기간을 모든 것에서 제외하고 나중에 유용한 곳에 추가해야합니까? 아니면 적합하다고 생각되는 마침표를 넣으시겠습니까? 예를 들어 모든 리소스 문자열 및 문장 인 예외 메시지 뒤에 있지만 단어 뒤에는없는 메시지입니다. 그렇다면 아주 짧은 문장은 어떻습니까? 예를 들어 "새 파일 만들기"와 같습니다. 행동으로 간주되는 문자열에 대해서도 마침표를 생략 할 수 있습니다 ... (여기에 입력하는 동안 생각 만하면 ...
세상에서 가장 중요한 것은 아닙니다. 그러나 잠시 후에 나를 괴롭히는 경향이있는 이와 같은 작은 것. 나는 일관성을 좋아하고 내가하는 일을하는 이유를 알고 있습니다. 문제는 어느 것을 갈지 잘 모르겠습니다.
예, 일반적으로 예외 메시지를 전체 문장으로 처리하고 마침표로 끝냅니다.
그러나, 예외의 메시지가위한 것입니다 개발자 및 되지 최종 사용자 . 예외 발생 메서드가 호출 된 컨텍스트에 따라 동일한 기본 예외로 인해 최종 사용자에게 두 개의 다른 메시지가 표시되어야합니다.
기술이 덜하고 사용자 친화적 인 메시지를 사용자에게 표시해야합니다.
Q. 예외 메시지를 마침표로 종료합니까?
에서 예외에 대한 모범 사례 † "예외 만들기 및 제기"섹션에 MSDN에 :
- 끝 문장 부호를 포함하여 문법적으로 올바른 오류 메시지를 사용 합니다. 예외 설명 문자열의 각 문장은 마침표로 끝나야합니다. 예 : "로그 테이블이 오버플로되었습니다." 적절한 설명 문자열입니다.
그리고 애플리케이션 사용자 인터페이스를 통해 사용자 에게 가능한 피드백과 관련 하여 질문에는 다음이 포함됩니다.
... 지역화 된 리소스 문자열에서도 문제가 될 수 있습니다.
위에서 언급 한 MSDN 문서에도 다음 내용이 나와 있습니다.
- 모든 예외에 지역화 된 설명 문자열을 포함합니다. 사용자에게 표시되는 오류 메시지는 예외 클래스가 아니라 발생한 예외의 설명 문자열에서 파생됩니다.
또한 "설명"섹션의 시작 부분에있는 Exception.Message 속성 † 에서 :
오류 메시지는 예외를 처리하는 개발자를 대상으로합니다. Message 속성의 텍스트는 오류를 완전히 설명해야하며 가능하면 오류를 수정하는 방법도 설명해야합니다. 최상위 예외 처리기는 최종 사용자에게 메시지를 표시 할 수 있으므로 문법적으로 정확하고 메시지의 각 문장이 마침표로 끝나는 지 확인해야합니다. 물음표 나 느낌표를 사용하지 마십시오. 애플리케이션에서 지역화 된 예외 메시지를 사용하는 경우 해당 메시지가 정확하게 번역되었는지 확인해야합니다.
† .NET Framework 4.6 및 4.5
프레임 워크의 예외 메시지는 점으로 끝납니다. 나는 그 이유 때문에 똑같이하는 경향이 있습니다.
어쨌든 스타일을 선택하고 그것에 충실하십시오 ...
예외 설명에 항상 마침표를 사용합니다. 간단한 사실은 적절하게 구두점이있는 문장이 읽기 쉽고 더 전문적으로 보이기 때문에인지 품질에 중요하다는 것입니다. 그렇지 않습니까?
비교 :
나는 항상 예외 설명에 마침표를 사용합니다. 단순한 사실은 적절하게 구두점이있는 문장이 읽기 쉽고 더 전문적으로 보이는 것이 지각 된 품질에 중요하다는 것입니다.
예외 메시지는 애플리케이션에 대한 개발자 인터페이스의 일부입니다. 인터페이스는 일반적으로 사용자가 특정 작업을 수행 할 수 있도록 설계되었습니다. 예외의 경우 제공된 인터페이스는 응용 프로그램 내에서 발생한 오류에 대한 정보를 전달하도록 설계되어야합니다.
예외를 던지고 다음과 같은 줄을 작성하기로 결정할 때
throw new ArgumentException("The string must contain at least one character.");
그런 다음 이미 다음을 포함하여 인터페이스에 대해 여러 가지 결정을 내 렸습니다.
- 예외 유형
- 지역화 된 예외 메시지 부족 (하드 코딩 된 문자열 사용은 일반적으로이를 의미 함)
- 이 예외는 다른 조건의 결과가 아닙니다 (내부 예외 없음).
개발자 인터페이스는 개발자에게 서비스를 제공하고 사용자 인터페이스는 사용자에게 서비스를 제공하기 위해 존재합니다. 전자는 후자와 크게 다른 요구 사항을 가지고 있으므로 한쪽에 좋은 것이 다른쪽에 좋지 않을 수 있으므로 예외 메시지의 기간은 문제가되지 않아야합니다. 사용자 인터페이스는 최종 사용자에게 표시되지 않아야합니다.
기간의 사용은 대부분의 경우 주요 결정이 아니지만 프레임 워크 일관성 및 현지화를 포함하여 이미 제기 된 포인트를 고려하여 존재 (또는 부족)가 인터페이스에 유익하거나 해로운 지 여부를 고려해야합니다.
나는이 포스트가 약간 장황하고 어쩌면 약간의 우주 비행 이라는 것을 알고 있지만, 당신에게 도움이되기를 바랍니다.
최선의 판단을 사용하십시오. 가끔 느낌표도 사용합니다. :-)
참조 URL : https://stackoverflow.com/questions/1136829/do-you-end-your-exception-messages-with-a-period
'programing' 카테고리의 다른 글
순환 가져 오기가없는 Python 유형 힌트 (0) | 2021.01.14 |
---|---|
Rxjs : Observable.combineLatest 대 Observable.forkJoin (0) | 2021.01.14 |
목록 상자를 목록에 바인딩 (0) | 2021.01.14 |
R로 SPSS 파일 읽기 (0) | 2021.01.14 |
stringio 객체를 어떻게 지우나요? (0) | 2021.01.14 |