让我们找出什么是注释以及为什么它们在编程中很重要。
我们还介绍了两种常见类型的注释以及如何用 15 种不同的编程语言编写它们。
目录
编程中的注释是什么？
通俗地说，注释是最终用户看不到的文本片段，供编写代码的人参考。
更正式一点，评论是对程序如何以简单可读的格式工作的描述。 这些通常用于需要向正在阅读代码的开发人员提供一些额外清晰度的地方。 因此，这有助于提高代码的可读性并减少传输知识所需的时间和交流。
编译器/解释器只是忽略代码中的注释，因此不会影响程序的最终输出。 所以简而言之，注释就像是对某些代码片段的简单易读的解释。
常见的评论类型
大多数编程语言都支持两种类型的注释。
- 单行注释
- 多行注释/块注释
顾名思义，单行注释在需要添加小的单行文本时很有用，例如。 一个特定的条件，一个需要简短描述的常量值。 而当我们有大量信息要添加时，多行效果更好，比如关于功能的描述以及如何使用它等。
还有一些其他类型的评论，如文档评论，但这超出了本文的范围。
为什么要添加评论？
“任何傻瓜都可以编写计算机可以理解的代码。 优秀的程序员编写出人类可以理解的代码。” – 马丁福勒
添加注释的主要优点是增强了程序的可读性和更好的理解。 除此之外，其他一些优势包括——
- 注释使您的同行甚至其他开发人员无需阅读冗长的文档即可非常容易地理解逻辑。
- 减少开发人员之间对小疑惑的沟通
- 编译器/解释器会忽略注释。
- 对于开源软件，这些是必须的，因为您不会在那里向数百万想要使用该特定程序的开发人员解释每个功能。
多语言评论
太棒了，现在我们了解了注释及其有用的原因。 让我们探讨一下如何使用不同的编程语言添加注释。
单行注释
// This is a single line comment in C/C++
多行注释
/* This is slightly long multi line comment in C/C++ */
单行注释
# This is a single line comment in Python
多行注释
# This is slightly long # multi line comment in Python
单行注释
// This is a single line comment in Java
多行注释
/* This is slightly long multi line comment in Java */
单行注释
# This is a single line comment in Ruby
多行注释
=begin This is slightly long multi line comment in Ruby =end
单行注释
// This is a single line comment in Golang
多行注释
/* This is slightly long multi line comment in Golang */
单行注释
– – This is a single line comment in Haskell
多行注释
{- This is slightly long
multi line comment in Haskell -}
单行注释
// This is a single line comment in Rust
多行注释
/* This is slightly long multi line comment in Rust */
单行注释
<!-- This is a single line comment in HTML -->
多行注释
<!-- This is slightly long multi line comment in HTML -->
单行注释
/* This is a single line comment in CSS */
多行注释
/* This is slightly long multi line comment in CSS */
单行注释
// This is a single line comment in Javascript
多行注释
/* This is slightly long multi line comment in Javascript */
单行注释
# This is a single line comment in R programming language
多行注释
R 不支持多行注释。
单行注释
% This is a single line comment in Erlang
多行注释
R 不支持多行注释。
单行注释
// This is a single line comment in PHP
多行注释
/* This is slightly long multi line comment in PHP */
单行注释
# This is a single line comment in Perl
多行注释
=begin This is slightly long multi line comment in Perl =end
单行注释
// This is a single line comment in Kotlin
多行注释
/* This is slightly long multi line comment in Kotlin */
结论
本教程涵盖了注释的基础知识和 2 种常见类型——单行和多行。 我还试图解释为什么评论有用，以及人们应该在需要时写评论。 我希望你学到了新东西！
继续探索。 保持学习！ 👨💻
