我可以在代码中使用日志代替注释吗？

Question

有人使用日志而不是评论吗？这样对吗？

例如：

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.');

在这种情况下，日志有两件事：日志和评论。

这是常见做法吗？

Answer 1

我相信评论和日志只是用于不同的目的。

进行日志记录是为了查看程序现在正在做什么或在特定点正在做什么。例如，您打开一个日志文件并检查五分钟前发生了什么以及现在发生了什么。当您并不真正关心到底在哪一行或哪个方法中发生了某些事情时，这很有用，您对事实更感兴趣，例如'User admin failed to login: invalid password'。显然，当您没有程序的源代码时，这会很有帮助。

注释可以帮助您理解这段代码的作用、这个特定函数正在做什么、为什么这个变量在这里以及这一切应该如何工作。但如果你只有一个二进制文件，注释就完全没有用了。

在我看来，你根本不能把它们搞乱，因为评论和日志记录是不同的。