黑马程序员 —— 注释的介绍及其使用

——Java培训、Android培训、iOS培训、.Net培训、期待与您交流！ ——-

一、注释的介绍

1、什么是注释？

　　在日常的程序开发中，为了便于记忆和理解相关的功能代码模块，也为了方便程序员之间的交流，一般会在代码中添加辅助内容，帮助解析代码理解，添加的这些辅助内容就叫做注释。

例如：

#include <stdio.h>//头文件，主要用来保证下面的printf函数运行int main(int argc, const char * argv[])//main函数，括号内是参数，可有可无{    // 我是注释    printf("黑马出品，必属精品!\n");//输出函数    return 0;//返回值}

　　双斜杠后面内容就是注释。

2、为什么要使用注释？

　　注释是对代码的解释说明，是写给程序员或项目经理看的，方便程序员之间交流，良好的代码注释习惯可提高程序的课读性。

3、注释的特点

　　注释是不参与编译的，遇到注释，编译器会直接跳过。

二、注释的分类

1、单行注释
　　使用斜杠 “//” 开头，后面跟着注释内容，只能在同一行，中间不能有回车，快捷键Command + / ，可以增加或取消单行注释。多行注释没有快捷键。

　　例如：下面这些都是单行注释。

#include <stdio.h>//头文件，主要用来保证下面的printf函数运行int main(int argc, const char * argv[])//main函数，括号内是参数，可有可无{    int userName;//定义用户名    userName = 12345678;//给变量赋值    printf("%d\n",userName);//输出用户名后换行    return 0;//返回值}

2、多行注释
　　使用/* /进行注释，两个 中间是注释内容，多行注释没有快捷键。

　　例如：

/** *  比较两个整数的大小，返回最大值 *  *  @param a 整数参数a *  @param b 整数参数b *  *  @return 返回两个整数的最大值 */int getMax(int a, int b){    if(a > b)//如果a大于b    {        return a;//返回a    }    return b;//否则返回b}

三、注释的使用注意

• 单行注释，只有这一行是注释，并且两个斜杠后面才是注释内容；
• Command + / ，可以增加或取消单行注释；
• 单行注释可以嵌套多行注释，但必须在同一行，这样写无意义；
• 多行注释是可以嵌套单行注释的；

• 多行注释不可以嵌套多行注释；

  比如下面这样写的多行嵌套是错误的。

/** *  比较两个整数的大少，返回最大值 * *  @param a 整数参数a *  @param b 整数参数b *  /*这是嵌套多行注释，是错误的写法*/ *  @return 返回两个整数的最大值 */int getMax(int a, int b){    if(a > b)//如果a大于b    {        return a;//返回a    }    return b;//否则返回b}