注释有哪几种形式？| 面经

注释的形式因编程语言的不同而有所差异，但一般来说，注释可以分为以下几种形式：

一、单行注释

单行注释是仅对一行代码进行注释的方式。不同的编程语言有不同的单行注释符号：

• //：这是最常见的单行注释符号，被许多编程语言如Java、C/C++、JavaScript、Kotlin等采用。在这些语言中，单行注释以“//”开头，后面的内容直到行尾都被视为注释。
• #：在某些编程语言中，如Python和Ruby，单行注释以“#”开头。
• Rem 或 '：在Visual Basic中，可以使用“Rem”关键字或单引号“'”来开始单行注释。

二、多行注释

多行注释用于对多行代码进行注释。不同的编程语言也有不同的多行注释符号：

• / ... /**：这是另一种广泛使用的多行注释符号，被C/C++、Java、JavaScript、Kotlin等语言采用。在这种注释方式中，“/”表示注释的开始，“/”表示注释的结束，两者之间的所有内容都被视为注释。
• 三个引号：在Python中，多行注释通常使用三个连续的单引号（'''）或三个连续的双引号（"""）来表示。这种方式不仅可以用于注释，还可以用于表示多行字符串。
• =begin ... =end：Ruby语言使用“=begin”来标记多行注释的开始，使用“=end”来标记多行注释的结束。

三、文档注释（特定于某些语言）

文档注释是一种特殊的注释形式，主要用于生成程序文档。不同的编程语言有不同的文档注释规范：

• Java：Java中的文档注释以“/**”开头，以“*/”结尾。这种注释通常用于类、方法、变量等的文档说明，可以通过Javadoc工具自动生成API文档。
• 其他语言：虽然文档注释在Java中特别常见，但其他语言（如C#、PHP等）也有类似的机制来支持文档注释的生成。

注意事项

• 注释不是给编译器看的，而是给人看的，因此应该保持注释的清晰和简洁。
• 适当的注释可以提高代码的可读性和可维护性，但过多的注释也可能使代码变得难以阅读和维护。
• 在使用注释时，应该避免在代码中加入误导性的注释，因为错误的注释可能会误导其他开发人员。

在我们编写代码的时候，如果代码量比较少，我们自己或者团队其他成员还可以很轻易地看懂代码，但是当项目结构一旦复杂起来，我们就需要用到注释了。注释并不会执行(编译器在编译代码之前会把代码中的所有注释抹掉,字节码中不保留注释)，是我们程序员写给自己看的，注释是你的代码说明书，能够帮助看代码的人快速地理清代码之间的逻辑关系。因此，在写程序的时候随手加上注释是一个非常好的习惯。

《Clean Code》这本书明确指出：

代码的注释不是越详细越好。实际上好的代码本身就是注释，我们要尽量规范和美化自己的代码来减少不必要的注释。

若编程语言足够有表达力，就不需要注释，尽量通过代码来阐述。

举个例子：

去掉下面复杂的注释，只需要创建一个与注释所言同一事物的函数即可

// check to see if the employee is eligible for full benefits
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

应替换为

if (employee.isEligibleForFullBenefits())

综上所述，注释的形式因编程语言的不同而有所差异，但主要包括单行注释、多行注释和文档注释三种形式。开发人员应该根据具体的编程语言和项目需求来选择合适的注释方式。