Dart SDK, руководство по стилю Dart и завершение сообщений об исключении точкой

Какое руководство по стилю рекомендуется?

  1. Завершение сообщений об исключении с точкой
  2. Не заканчивать сообщения об исключениях точкой
  3. Это дело вкуса

В Dart SDK я обнаружил, что в некоторых сообщениях (даже внутри одной и той же реализации класса ошибок / исключений) используются разные стили (с и без знака точки в конце текстового сообщения).

Какой стиль я должен использовать?

PS

Если я правильно понимаю (в соответствии с реализацией классов ошибок "dart:core" в Dart SDK), то я должен выбрать вариант № 3 (это дело вкуса).

Вот ссылка на тот же вопрос о C#. Вы заканчиваете свои сообщения об исключении точкой?

Я задаю этот вопрос (это ответ на комментарий Гюнтера Цохбауэра) о переполнении стека, но не о трекере проблем дротиков, потому что я думаю, что мой вопрос и вопрос C# (упомянутый выше) оба являются хорошими вопросами.

На практике они должны помочь лучше написать исходный код (по крайней мере, сообщения об ошибках).

1 ответ

Нет строгого правила, главным образом потому, что никто не сообщил об этом как о проблеме.

Лично я бы пошел: если это предложение, используйте точку. Если это сообщение не из предложения, не стесняйтесь использовать пунктуацию.

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

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

Другие вопросы по тегам