2015-12-14 4 views
1

Кто-нибудь использует журналы вместо комментариев? Это правильно?Могу ли я использовать журналы вместо комментариев в своем коде?

Например:

logger.debug('Fingerprint is not specified. Returning only message that password is correct in response.'); 
logger.info('Password is correct. But fingerprintId was not passed. User ID:', foundUser.id); 
logger.debug('Returning success message in response.'); 

Вход в этом случае делает 2 вещи: ведение журнала и комментариев.

Это обычная практика?

+0

Возможно, это будет помечено _python_ – ForceBru

+0

. Я думаю, что это общий вопрос. Например, я кодирую сервер с js и андроидным приложением в java. – raiym

+0

ваш пример кода выглядит как Python, но это нормально, если ваш вопрос может быть применен к любому языку. Кстати, о каких комментариях вы говорите? В исходном коде? – ForceBru

ответ

1

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

Завершение работы , чтобы увидеть, что делает ваша программа прямо сейчас или что она делает в определенный момент. Например, вы открываете файл журнала и проверяете, что происходит пять минут назад и что происходит сейчас. Это полезно, когда вы действительно не беспокоитесь о том, что вы действительно не беспокоитесь , на какой строке или в каком методе точно что-то происходит, вас больше интересуют факты, такие как «Пользователь не смог войти в систему: неверный пароль». Очевидно, что это помогает, когда у вас нет исходного кода программы.

Комментарии поможет вам понять , что делает этот код, то, что эта конкретная функция делает, почему эта переменная является здесь и , как все это должно работать. Но если у вас есть только двоичный код, комментарии абсолютно бесполезны.

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

Смежные вопросы