如果在同一文件中重复相同的代码,应该重复注释吗?

问题描述 投票:0回答:2

如果我要在同一文件的多个位置/功能中重复使用相同的代码,我应该一遍又一遍地重复相同的注释,还是只重复一次?注释的协议/标准编码实践会随每种语言变化吗?

comments
2个回答
1
投票

Mu。您根本不应该重复这样的代码。将其重构为一个函数,因此您只需编写一次即可。


1
投票

注释的协议/标准编码惯例是否随每种语言而改变?

不是,我已经用多种语言编程,我的评论心态没有改变。

如果我要在同一文件的多个位置/功能中重复使用相同的代码,我应该一遍又一遍地重复相同的注释,还是只重复一次?

我应该在注释中解释每个函数每次打开文件或关闭文件时发生的情况吗?

您只应注释掉代码中未明确显示的内容。如果在代码中,您在多个位置重复相同的代码块,那么这不是一个好习惯,您应该使用functions(如@Joseph Sible-Reinstate Monica所说)将重复的代码放入语句块中,然后通过调用函数来重用它。另外,如果要在另一个函数中重复一个函数的代码,请记住,可以从另一个函数内部调用一个函数,以避免codeduplication。因此,如果您选择后者,则可以仅注释主要函数的功能,并且当用户在另一个函数中看到该函数时,他可以返回您的代码并检查原始函数的注释。

而且,根据标准惯例,代码的某些方面是否应该注释?

再次仅注释代码中未显式的内容,例如,如果您有一个仅显示文本的函数,则不需要注释,但是相反,如果您的代码使用外部依赖项或您自己的类,则好的做法是评论它们在您的代码中的作用;本质上解释了您的代码如何利用这些资源。

© www.soinside.com 2019 - 2024. All rights reserved.