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

Question

许多当代语言允许两种注释：一种是在两端使用分隔符（多行注释），另一种是分隔符仅标记注释的开头（一行注释）。讨论每个标准（可读性，可写性，可靠性，成本）的优缺点。

Answer 1

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

两者都有一个易于写/读的评论。评论可能只要你想要，但通常短的和精确的评论更好，否则你只会将代码重写为评论。

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

此评论如何帮助未来的用户？

但是，使用多行，您可以编写一些文本，但如果您仍然必须阅读（并理解）代码，那么阅读它将是一项额外的工作。 它不会改变程序员阅读它们的方式，但是当你有多行注释（比如参考URL）并且不希望用注释标记开始每一行时，它们肯定会有所帮助。

我个人喜欢多行代码，原因很简单：它将逻辑部分组合在一起

//*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++
//*/