Вы заканчиваете сообщения об исключениях с периодом?

Я видел сообщения об исключениях с периодом и без него. И я могу думать о некоторых причинах того, почему оба могут быть хорошими.

Никакая точка не даст вам свободу добавлять период или оставить его, если вы хотите. Может быть полезно, если сообщение собиралось в виде заголовка или чего-то еще.
С точкой, которую вы всегда знаете, что у вас есть "полное предложение", и выглядит более законченным.

Какой из них вы рекомендуете?

Также может быть проблемой в локализованных строках ресурсов. Очевидно, что вы не можете поставить период после всего (будет выглядеть странно с периодами после текста на кнопках и пунктах меню и т.д.). Но должны ли вы оставить период от всего, чтобы быть последовательным, и добавить его позже, когда это полезно? Или вы предпочли бы поставить период, когда он кажется подходящим? Например, после всех строк ресурсов и сообщений об исключениях, которые являются предложениями, но не после тех, которые являются словами. Но тогда, как насчет очень коротких предложений? Например, например "Создать новый файл". Могли бы, возможно, оставить периоды для строк, которые также считались действиями... (Просто подумайте, пока я набираю здесь...

Не самое важное в мире, я знаю. Но такие мелочи, которые, как правило, меня мучают через некоторое время. Мне нравится последовательность и знать, почему я делаю то, что делаю. Проблема в том, что я не уверен, для чего нужно: p

Ответ 1

Да Обычно я рассматриваю сообщения об исключениях как полные предложения, заканчивая их периодом.

Однако сообщение в исключении предназначено для разработчика, а не для конечного пользователя. Вполне возможно, что одно и то же основное исключение должно приводить к двум различным сообщениям для конечного пользователя в зависимости от контекста, в котором был вызван метод исключения.

Вам действительно нужно показывать пользователям менее технические, более удобные для пользователя сообщения.

Ответ 2

Q. Вы заканчиваете сообщения об исключениях с периодом?

From Best Practices for Exceptions ^† on MSDN in the section "Creating and raising exceptions":

Используйте грамматически правильные сообщения об ошибках, включая окончание пунктуация. Каждое предложение в строке описания исключения должен заканчиваться через определенный период. Например, "Таблица журналов переполнена". будет подходящей строкой описания.

И в отношении возможной обратной связи с пользователем через пользовательский интерфейс приложения, вопрос включает в себя:

... Также может быть проблемой в локализованных цепочках ресурсов.

В статье MSDN, упомянутой выше, также указано:

Включить локализованную строку описания в каждом исключении. Ошибка сообщение, которое видит пользователь, выводится из строки описания исключение, которое было выбрано, а не из класса исключений.

Also, from Exception.Message Property ^† at the beginning of the section "Remarks":

Сообщения об ошибках предназначены для разработчика, который обрабатывает исключение. текст свойства Message должен полностью описывать ошибку и, когда это возможно, также следует объяснить, как исправить ошибку. Верхний уровень обработчики исключений могут отображать сообщение конечным пользователям, поэтому вы должны убедитесь, что оно является грамматически правильным и что каждое предложение сообщение заканчивается периодом. Не используйте вопросительные знаки или восклицания точки. Если ваше приложение использует локализованные сообщения об исключениях, вы должны обеспечить их точное перевод.

^†.NET Framework 4.6 and 4.5

Ответ 3

Сообщения об исключении в структуре заканчиваются точкой; По этой причине я, как правило, делаю то же самое. В любом случае выберите стиль и попытайтесь придерживаться этого...

Ответ 4

Я всегда использую периоды в описаниях исключений. Простой факт заключается в том, что предложения, которые должным образом перемежаются, легче читать и более профессионально выглядят, что важно для воспринимаемого качества - разве вы не думаете?

Сравните это с:

Я всегда использую периоды в своих описаниях исключений, простой факт состоит в том, что предложения, которые должным образом перемежаются, легче читать и более профессионально выглядят, что важно для воспринимаемого качества, и не думайте

Ответ 5

Сообщения об исключении составляют часть интерфейса разработчика для вашего приложения. Интерфейсы обычно разработаны с целью помочь пользователю выполнить определенную задачу. В случае исключения, предоставляемый интерфейс должен быть предназначен для передачи информации об ошибке, которая произошла в приложении.

Когда вы решите выбросить исключение и напишите строку, например

throw new ArgumentException("The string must contain at least one character.");

то вы уже приняли ряд решений по интерфейсу, включая:

Тип исключения
Отсутствие локализованных сообщений исключений (использование жестко заданной строки обычно подразумевает это)
Это исключение не является результатом каких-либо других условий (без внутреннего исключения)

Помните, что интерфейс разработчика существует, чтобы обслуживать разработчиков и пользовательский интерфейс для обслуживания пользователя, первый имеет совершенно разные требования, чем последние, поэтому то, что хорошо для одного, может быть не очень хорошим для другого, поэтому период в сообщении об исключении не должен касаться пользовательского интерфейса, поскольку он не должен быть видимым для конечного пользователя.

Использование периода не является основным решением в большинстве случаев, но вы должны подумать о том, выгодно ли оно (или его отсутствие) для интерфейса, рассматривая уже поднятые вопросы, включая согласованность и локализацию структуры.

Я знаю, что этот пост немногословен и, возможно, немного астронавт, но я надеюсь, что он вам полезен.

Ответ 6

Используйте свое лучшее суждение. Иногда я использую восклицательный знак.: -)