使用注释的要点
注释的目的:
为了让程序更方便阅读(“可读”),以便于维护。
需要注释的内容:
- 重要变量名的作用(用来表示什么)
- 比较复杂的算法思想
- 程序中的关键步骤
注释的方式
有两种注释方式
1.单行注释 //
在行尾,或代码的上一行
在代码的下一行也可以,但很少有人这么做。
2.多行注释 /* */
不支持嵌套。
3.不要为了注释而注释!
过多的注释,反而有害!会把真正需要注意的东西淹没。
...... int i; //定义了一个变量i ......
注释的风格
函数的注释,有特别的“姿势”,可以让代码显得更规范。
1.在行尾注释 使用//注释
2.在代码的上一行使用//注释
3.多方内容的注释,使用 /* */