4、C语言编程：注释、实验与程序结构解析

C语言编程：注释、实验与程序结构解析

1. 代码注释的艺术

1.1 注释的高级原则

• 描述代码意图 ：注释应描述代码的意图以及解决问题的方式。注释的层次越高，代码变更时注释需要修改的可能性就越小。
• 传达编写目的 ：通过注释传达代码编写的原因和想要达成的目标，而代码实际执行的操作应从代码本身体现。

1.2 注释实践中的问题与启示

• 回顾自己6个月前写的代码时，常因注释不足而困惑，也会因注释过多在修改代码时删除大量无用注释。但专注于代码意图进行注释时，很少会出现注释过多的情况。
• 曾遇到注释与代码完全不匹配的情况，这是因为程序员最初的算法设计与后续代码修改差异过大。除非确定理解代码且注释与代码不符，否则不要轻易删除注释。

1.3 为“Hello, world!”程序添加注释

将 hello1.c 复制为 hello2.c ，并添加如下注释：

/*
 * hello2.c
 * My first C program with comments.
 * by <your name>
 * created yyyy/mm/dd
 */
#include <stdio.h>
int main()
{
    printf( "Hello, world!\n" );
    return 0;
}