类型的评论

类型的评论

注释是一个线（或多线）的文本，插入到源代码解释代码是做什么的。在C++中有两种类型的注释。

/ /符号开始一个C++单行注释，它告诉编译器忽略一切到终点。比如说呢。

1

cout <<“Hello World！”<< endl；/一切从这里到权利被忽略。

通常，单行评论是用来使一个单一的代码行快速评论。

1

2

3

cout <<“Hello World！”<< endl；/ cout和endl住在iostream库

cout <<“见到你真高兴！”<< endl；/这些评论使代码难以阅读

cout <<“是的！”<< endl；/特别是当线路长度不同

有注释行的权利可以使两个代码和注释难读，尤其是如果线是长。因此，/ /的评论往往是放在上面的线是评论。

1

2

3

4

5

6

7

8

/ / cout和endl住在iostream库

cout <<“Hello World！”<< endl；

/这是更易于阅读

cout <<“见到你真高兴！”<< endl；

你难道不同意吗？

cout <<“是的！”<< endl；

/*和*/对符号表示一个C风格的多行注释。之间的一切符号被忽略。

1

2

3

/这是一个多行注释。

这条线将被忽略。

所以将这一。* /

由于符号之间的一切都是不容忽视的，有时你会看到“美化”多行注释的程序员：

1

2

3

4

/这是一个多行注释。

*匹配星号左侧

*能使这个过程更容易阅读

* /

多线式注释不能嵌套。因此，下面会有意想不到的结果：

1

2

这是一个多行/ / * * *评论/这是不是在评论*/

/ / ^评论在这里结束

规则：不要嵌套注释里面其他的评论。

采用适当的评论

通常，意见应用于三件事。在图书馆，程序，或功能水平，意见应用于描述库，程序，或功能，并。比如说呢。

1

/ /本程序计算出学生的最终成绩基于他的作业与考试成绩。

1

//这个函数使用牛顿的方法近似一个给定的方程的根。

1

//下面的线产生的基础上的稀有性，随机项目的水平，和一个权重因子。

所有这些评论给读者一个好主意是什么程序试图不看实际的代码实现。用户（可能是其他人，或者你如果你想重用代码你已经写在未来）一眼就能看出代码是有关他或她所要完成的。这是特别重要的工作作为一个团队的一部分，而不是每个人都熟悉的所有代码。

第二，在图书馆，程序，或上述功能，注释应该用来描述代码是如何去完成它的目标。

1

2

3

/*计算出最终的成绩，我们和所有的加权的中期和作业成绩

然后除以多少分数分配比例。这个百分比

用于计算一个字母等级。* /

1

2

3

4

5

6

/ /来生成一个随机的项目，我们将做如下：

/ / 1）把所有所需的罕见的在名单上

/ / 2）计算每个项目的概率基于水平和权重因子

/ / 3）选择一个随机数

/ / 4）找出这项随机数对应

/ / 5）返回适当的项目

这些话让用户了解代码去完成它的目标，没有太多的细节。

在语句级别，评论应该被用来描述为什么代码是做什么。一个坏的声明注释说明代码是做什么的。如果你写的代码是非常复杂的，需要一个注释来解释声明是干什么的，你可能需要重写你的代码，而不是评论。

这里有一些坏线的意见和评论的例子很好的陈述。