Номер ошибки

Question

Зачем вы добавляете

// Ошибка 1024

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

Answer 1

Мы работаем в крупномасштабной системе со многими разработчиками и несколькими выпущенными ветками.

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

Если исправление было простым, то для него может не потребоваться маркер ошибки. Если это неочевидно, возможно, имеет смысл обратиться к ошибке, чем написать длинное объяснение в разделе комментариев.

Answer 2

Вы бьете гвоздь по голове с «релевантность очень коротка, и они имеют тенденцию накапливать засорение базы кода».

Каждый бит бесполезной лжи, который накапливается в исходных файлах, делает их немного менее читабельными и сложными в обслуживании. Удалите все, что не добавляет ценности. «Ошибка 12345» сейчас мало что значит, и через несколько недель ее не будет.

Answer 3

Я делал это вплоть до выпуска Visual Studio 2008 с аннотацией. При взгляде на старый код было полезно сразу увидеть, что, по крайней мере, задумывалось конкретное решение кода.

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

Answer 4

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

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

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

Answer 5

Если вы просматриваете незнакомый исходный код и видите что-то неочевидное, приятно знать причину. Хотя это и есть суждение, не каждое исправление ошибки нуждается в таком объяснении - вероятно, большинство может обойтись без него.

Answer 6

Это хорошо!

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

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

Answer 7

Этот тип комментариев IS очень полезен: что происходит, когда вы меняете инструменты отслеживания ошибок или контроля версий? Ссылка на BZ1722 против FB3101 скажет вам, какой инструмент отслеживания следует проверить (например, Bugzilla или FogBugz).

Answer 8

Мне не нравятся такие граффити. Как и другие неприятные формы жизни, они накапливаются со временем, задыхаясь от кода.

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