Удалить #ifdef части DEBUG для выпуска или нет?

Question

При выпуске исходного кода для просмотра кем-то еще, когда стиль кодирования не определен (не каламбур) Вы удаляете части #ifdef DEBUG?

(то есть части, которые компилируются, только когда определено DEBUG)

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

Что делать?

Answer 1

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

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

Answer 2

Я также голосую за то, чтобы оставить его. Если / когда вы начнете работу над своим первым патчем, вам, вероятно, понадобятся эти блоки с DEBUG. Кроме того, QA не понравится, что вы удалили код, даже если он заблокирован в директиве.

Answer 3

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

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

Answer 4

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

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

Не обслуживайте эти вторичные отфильтрованные репозитории, всегда создавайте их.

Но стоит ли это времени? Вероятно, нет, и вам, вероятно, следует просто распространить все, включая части #ifdef DEBUG.

Answer 5

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

Answer 6

Поддержка нескольких версий НИЧЕГО нежелательна.

Делайте это только если вы должны .