计算机编程中的注释概念

注释是添加到程序中的文本注释，用于提供有关源代码的解释性信息。它们在编程语言中用于记录程序并提醒程序员他们刚刚对代码做了哪些棘手的事情，也有助于后代理解和维护代码。编译器将这些视为不可执行的语句。不同的编程语言使用不同的方式在源代码中包含注释。

/* this is a comment in C. 
This comment syntax is guaranteed to
work on every compiler */
  
// This is also a comment in C
// but it might present portability challenges

评论可用于各种目的，例如：

计划和审查：在评论中，我们可以在编写源代码之前编写我们计划的伪代码。伪代码是自然语言和高级编程语言的混合体。这有助于更轻松地查看源代码，因为伪代码比程序更容易理解。
例子 -
```
// GCD BY EUCLID'S ALGORITHM
/* Euclid(m, n)
{
      while m does not divide n
      r = n mod m
      n = m
      m = r
      end
      return m
}
*/
```
在上面的例子中，我在注释中写了 gcd 的伪代码。这将有助于代码的实现。

代码描述：程序员使用代码描述来让其他人了解他/她的意图。它包含代码的摘要。

{
    /* A Multiline Comment --
           Define a variable of
           string type and assign
           value to it*/
    string msg = "GeeksforGeeks";
}

算法描述：注释用于解释方法。这样的解释可能包括图表和正式的数学证明。这可能构成对代码的解释，而不是对其意图的澄清。例如，程序员可以添加注释来解释为什么选择插入排序而不是快速排序，因为从理论上讲，前者比后者慢。
```
list = [ f(b), f(b), f(c), f(d), f(a), ... ];
  
// Need a stable sort. Besides,
// the performance really does not matter.
insertion_sort(list);
```
资源包含：由 ASCII 艺术结构组成的徽标、图表和流程图可以插入到格式化为注释的源代码中。此外，版权声明可以作为注释嵌入源代码中。
元数据：评论还包含程序的元数据。此元数据有助于软件维护。元数据包括原始版本的创建者姓名、程序的当前维护者、创建第一个版本时的数据、迄今为止编辑程序文件的人员的姓名等。
调试：蛮力法是一种常用的调试方法。在这种方法中，在整个程序中插入打印语句以打印中间值，希望打印的一些值有助于识别错误。在进行调试之后，我们对这些打印语句进行注释。因此，注释也用于调试。
```
int fun(int m)
{
    int count = 0;
    while (m > 10) {
  
        // printf("m is less than 10, m=%d", m);
        count++;
    }
    return m;
}
```
自动文档生成：编程工具有时将文档和元数据存储在注释中。这些可能包括用于自动包含头文件的插入位置、设置文件语法突出显示模式的命令或文件的修订号。这些功能控制注释通常也称为注解。将文档保存在源代码注释中被认为是简化文档过程的一种方法，同时增加了文档随着代码更改而保持更新的机会。
缓解压力：评论开发工具、竞争对手、雇主、工作条件或代码本身的质量是缓解压力的方法。从跟踪源代码中的亵渎行为的在线资源中可以很容易地看到这种现象的发生。

详细了解 C/C++、 Java、HTML、C# 中的注释