您好,欢迎访问本站博客!登录后台查看权限
  • 欢迎大神光临
  • 有朋自远方来 不亦悦乎

C++零基础入门教程3:注释,良言一句三冬暖 恶语伤人六月寒

C/C++ dz2015 2017-09-04 317 次浏览 0个评论

注释,就是在代码文件中添加和逻辑无关的说明内容,或者将某些不用的代码注释掉,不参与编译。

捕获3.PNG

注释实例赏析

添加注释后的cpp_demo1.cpp

/*
 入口函数。
 */
int main() {
    return 0; // 正确结束,返回0,执行错误返回非0值
}

注释方式有两种, "//"只可以注释单行内容,注释符号前为代码内容,之后的内容一直到行结束都是注释内容。“/**/”之间的任何内容都是注释内容,这种注释可以跨多行,也可以只在一行,甚至可以插在代码间。

我们再看看几种注释例子。注释没有什么格式要求,完全可以按照个人喜好来写,但是同一个项目中,不要使用多种风格。下面给出了一些例子。

/**
 * 计算两个数的和
 * @param a 加数
 * @param b 被加数
 * @return 和
 */
int add(int a, int b) {
    /*
    int c = a + b; // 计算和
    return c; // 返回和 
     */
    return a + b; // 计算并返回和
}

上面的注释对函数功能、参数、和返回值进行了说明,这种为JavaDoc注释风格,当然这只是风格的一部分。函数中对暂时无用的代码进行了注释,“”这种注释不是为了说明,而是为调试用的,所以留着,“// 计算和”也成了注释的一部分,注释符号在注释内容中,就成了普通的注释内容。

/*[]**********************************************[]*
 *  对两个数进行相减。
 *  参数a:减数
 *  参数b:被减数
 *  返回值:差
 *[]**********************************************[]*/
int sub(int a, int b) {
    return a -/*+*/ b; // 计算并返回差
}

上面这种是非大众化的个人注释。另外函数中的“/*+*/”也是符号注释语法的哦,很灵活。

///
/// 计算两个数的积。
/// @param a 乘数
/// @param b 乘数
/// @return 积
int mul(int a, int b) {
    return a * b;
}

这是C++自己的注释风格。

练兵场

对之前写的代码添加注释。


已有 317 位网友参与,快来吐槽:

发表评论