多行注释和单行注释的优点和缺点



许多现代语言允许两种注释:一种是在两端都使用分隔符(多行注释),另一种是分隔符只标记注释的开头(单行注释)。讨论每种标准的优缺点(可读性、可写性、可靠性、成本)。

这里没有正确的答案,它们在个人或风格上的编码方式不同。

两者都有,你有一个易于写/读的评论。注释可以是您想要的长度,但通常简短而精确的注释会更好,否则您只会将代码重写为注释。

//assings 10 to x will make everything happier // the code won't change (further reading)
x = 10
if (x == 10) 
    happy++

这条评论对未来的用户有何帮助?

不过,对于多行代码,您可以写一些文本,但如果您仍然必须阅读(并理解)代码,那么阅读它将是一项额外的工作。这不会改变程序员阅读它们的方式,但当你有多行注释(比如引用URL),并且不想每行都以注释标记开头时,它们确实会有所帮助。

I、 就个人而言,像多行代码一样,原因很简单:它将逻辑部分拼凑在一起

//*assings 10 to x will make everything happier //the code is on
x = 10
if (x == 10) 
    happy++
//*/

现在,我只需更改第一个"/",就可以很容易地打开和关闭代码的这一部分(例如,用于测试)。这将是多行的优势。

/*assings 10 to x will make everything happier // the code is off
x = 10
if (x == 10) 
    happy++
//*/

最新更新