爬虫 微博评论记录
当我最近的文章在dzone上重新发布时,乔纳森·费舍尔(Jonathan Fisher)添加了一个有价值的评论,指出:
…
我想我还有别的事情要写:“登录还是发表评论?” 我将调试语句看作是“活动注释”,它可以向下一个人解释程序的执行,但是在生产中也可以提供有价值的intel。
我只见过一次练习。 有一个具有严格编码规则的编码环境,禁止注释。 他们说您应该在接口上评论Javadoc,但别无其他。 如果您的代码不可读,请阅读代码并进行单元测试,则必须更改您的代码。
在这种环境下,想发表评论的程序员很快就开始使用日志。 但是在开始之前,让我们先看看原因。
评论不好吗?
一般来说,评论是不好的。 当汇编语言和FORTRAN是编程语言时,还不错。 这些语言是为了生成可执行代码,而不是表达想法。 今天的语言更多地关注于表达性,易于编码以及从概念到可执行文件的翻译,这比编译器在FORTRAN时代所能完成的更多。 现在,我们拥有CPU和内存来编译Java,Groovy,Scala等语言。 当这些语言出现时,您感觉需要注释,您必须考虑两件事:
- 您的代码真的可读吗? 难道只是为了表达刻在评论中的想法而被重写吗?
- 您要输入为注释的信息真的是注释吗? 还是应该将其作为文档的一部分,而不应该放入代码中?
如果你认为你可以不写代码更具表现力,因为业务领域仅仅是复杂的,不适合的代码,请访问文章代码文档的黄金法则和咆哮的挑战。
注释将由维护您的代码的程序员阅读。 如果这些词更适合Wiki中的文档,请不要分散关注您的程序员的注意力。
日志不好吗?
通常,日志记录是好的。 但是,如果通过日志记录来克服注释限制,那么就可以使用好的武器。 别。 它是比日志记录更笼统的概念。 事实上,它甚至比编程还要广泛。 不要使用非设计工具。
担心日志记录会降低性能。 使用现代loggig库和解决方案时,除了边缘情况外,这不应成为认真考虑的因素。 即使是这样,也请先测量然后再调整。 不要对性能有偏见或有任何先决条件。
结论
日志应该增加可读性。 由于这是一个单独的方面,因此不同于该代码所开发的原始业务方面,因此存在插入日志记录语句会降低可读性的危险。 在开发代码时,应注意这一点。 例如,我建议您不要外部化或使用字段/变量存储日志记录字符串。 记录文本应该说明语句在哪里。
勇敢地插入日志记录语句,不要犹豫。 在进行代码审查时,要考虑到有两个日志语句序列。 阅读代码时,一个序列是线性的。 另一个顺序是程序执行后,打印输出如何进入日志文件。 进行涉及生产,支持人员的日志审查可能是一个好习惯。 它可以类似于代码审查:全面关注生成的日志并提供有关可读性的反馈。 我曾经经历过这种临时性的活动,但是从来没有计划过的活动。 如果有人尝试,请提供反馈。
通常:记录日志。 使用评论进行评论。 如果必须挖掘坟墓,请使用铁锹。 如果您有钉子:请使用锤子。 使用适当的工具,请勿混合使用。
翻译自: https://www.javacodegeeks.com/2014/07/logging-or-commenting.html
爬虫 微博评论记录