c++注释佛
C++注释
2015-10-28 14:21:53 tingyue_ 阅读数 376

下面的文章转载自:
http://hi.baidu.com/buptyoyo/blog/item/fc8bdfee2ea1793326979114.html
http://blog.csdn.net/lincyang/article/details/6020785#t0
1 源文件头部注释

Ø 列出:版权、作者、编写日期和描述。
Ø 示例:

/************************************************* 
Copyright:bupt 
Author: 
Date:2010-08-25 
Description:描述主要实现的功能 
**************************************************/  

每行不要超过80个字符的宽度。

2 函数头部注释

Ø功能、输入参数、输出参数、返回值、调用关系(函数、表)等。
Ø 示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议
要包含在内。

/************************************************* 
Function:       // 函数名称 
Description:    // 函数功能、性能等的描述 
Calls:          // 被本函数调用的函数清单 
Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序) 
Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序) 
Input:          // 输入参数说明,包括每个参数的作 
                  // 用、取值说明及参数间关系。 
Output:         // 对输出参数的说明。 
Return:         // 函数返回值的说明 
Others:         // 其它说明 
*************************************************/  

3 数据结构声明的注释(包括数组、结构、类、枚举等)

Ø如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。
Ø 示例:可按如下形式说明枚举/数据/联合结构。

/* sccp interface with sccp user primitive message name */  
enum SCCP_USER_PRIMITIVE  
{  
    N_UNITDATA_IND, /* sccp notify sccp user unit data come */  
    N_NOTICE_IND,   /* sccp notify user the No.7 network can not */  
                    /* transmission this message */  
    N_UNITDATA_REQ, /* sccp user's unit data transmission request*/  
};  

4 全局变量的注释

Ø 包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
Ø示例:

/* The ErrorCode when SCCP translate */  
/* Global Title failure, as follows */      // 变量作用、含义  

5 对代码的注释
注释总是加在程序的需要一个概括性说明或不易理解或易理解错的地方。注释语言应该简练、易懂而又含义准确,避免二义性;所采用的语种首选是中文,如有输入困难、编译环境限制或特殊需求也可采用英文。注释应与其描述的代码相近,对代码的注释统一放在其上方,避免在一行代码或表达式中间使用注释。上方注释与其上面的代码用空行隔开(较紧凑的代码除外)。
注意:注释应与所描述内容进行同样的缩进。

c++注释
2017-11-23 20:19:53 leek5533 阅读数 263

块注释符(/*...*/)是不可以嵌套使用的。

此外,我们还可以使用 #if 0 ... #endif 来实现注释,且可以实现嵌套,格式为:

#if 0
   code
#endif 

你可以把 #if 0 改成 #if 1 来执行 code 的代码。

这种形式对程序调试也可以帮助,测试时使用 #if 1 来执行测试代码,发布后使用 #if 0 来屏蔽测试代码。

#if 后可以是任意的条件语句。

C++注释
2018-11-07 10:14:06 Fly_hps 阅读数 107

C++ 注释

程序的注释是解释性语句,您可以在 C++ 代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。

C++ 支持单行注释和多行注释。注释中的所有字符会被 C++ 编译器忽略。

C++ 注释以 /* 开始,以 */ 终止。例如:

/* 这是注释 */
 
/* C++ 注释也可以
 * 跨行
 */

注释也能以 // 开始,直到行末为止。例如:

#include <iostream>
using namespace std;
 
int main()
{
   cout << "Hello World"; // 输出 Hello World
 
   return 0;
}

当上面的代码被编译时,编译器会忽略 // 输出 Hello World,最后会产生以下结果:

Hello World

在 /* 和 */ 注释内部,// 字符没有特殊的含义。在 // 注释内,/* 和 */ 字符也没有特殊的含义。因此,您可以在一种注释内嵌套另一种注释。例如:

/* 用于输出 Hello World 的注释
 
cout << "Hello World"; // 输出 Hello World
 
*/

附加:

块注释符(/*...*/)是不可以嵌套使用的。

此外,我们还可以使用 #if 0 ... #endif 来实现注释,且可以实现嵌套,格式为

#if 0
   code
#endif 

你可以把 #if 0 改成 #if 1 来执行 code 的代码。

这种形式对程序调试也可以帮助,测试时使用 #if 1 来执行测试代码,发布后使用 #if 0 来屏蔽测试代码。

#if 后可以是任意的条件语句。

下面的代码如果 condition 条件为 tre 执行 code1 ,否则执行 code2。

#if condition
  code1
#else
  code2
#endif

 

2017-12-10 12:41:57 qq_38131668 阅读数 2066

程序的注释是解释性语句,您可以在 C++ 代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。
C++ 支持单行注释和多行注释。注释中的所有字符会被 C++ 编译器忽略。
C++ 注释以 /* 开始,以 */ 终止。例如:

/* 这是注释 */

/* C++ 注释也可以
 * 跨行
 */

注释也能以 // 开始,直到行末为止。例如:

#include <iostream>
using namespace std;

int main()
{
   cout << "Hello World"; // 输出 Hello World

   return 0;
}

当上面的代码被编译时,编译器会忽略 // 输出 Hello World,最后会产生以下结果:

Hello World

在 /* 和 */ 注释内部,// 字符没有特殊的含义。在 // 注释内,/* 和 */ 字符也没有特殊的含义。因此,您可以在一种注释内嵌套另一种注释。例如:

/* 用于输出 Hello World 的注释

cout << "Hello World"; // 输出 Hello World

*/
C++注释
2010-09-13 09:05:00 hongloumengyan 阅读数 417

C90只有一种注释风格,就是使用“/*”和“*/”。早在预处理阶段,C预处理器就会剔除所有出现在“/*”和“*/”之间的内容(包括这对记号本身),所以在接下来传送到C编译器的代码文件里是不会出现任何注释内容的。
   但这么简单的注释风格有时也会令人头疼。例如,你可能想,什么是注释呢?注释就是写什么东西都无所谓,反正编译器不会看到这些东西。很不幸,C预处理器一般都不支持嵌套注释,如果你这样写:

       /*something /* something else */*/

       是行不通的。因为预处理器在碰到第一个“*/”时就认为注释已经结束!于是它把到这里为止的注释移除,可想而知,结果留下孤零零一个“*/”—编译程序又报错了。

       这样的处理常常令我们很不舒服,例如有时我们调试代码,需要把连续几行代码注释掉观察结果,做法自然是这样写:

       语句1;

              语句2;

              /*

                     语句3;

              */

              语句4;

       语句5;

       但随着调试的深入,可能我们想连语句2、语句4都注释掉:

       语句1;

       /*

              语句2;

              /*

                     语句3;

              */

              语句4;

       */

       语句5;

       多加一对注释不就解决了?

       --中招了。看,你用了嵌套注释。

       为了解决这个问题,C++引入另一种风格的注释:使用“//”。预处理器会删除从“//”开始到后面碰到的第一个换行符之间的所有内容。这样就没有嵌套注释的问题了,只不过书写有点繁琐,例如:

       语句1;

       //语句2;

       //语句3;

       //语句4;

       语句5;

       你喜欢注释哪一行都可以,随时可以撤消注释,干脆利落,绝对没有副作用,当然,前提是你一行只写一个语句。

       资深程序员一般都更乐意使用C++风格的注释,我也如此建议。不过,你会问,C预处理器可不认识“//”啊?

       其实多数C预处理器都“暗中”支持“//”,除非你使用“严格符合C90”之类的编译选项,否则C预处理器是不会阻挠你的。

       而且,有个好消息:

       C99已经正式采纳C++的注释风格,在今后,你可以光明正大的使用“//”。当然,原来的老风格仍然可以继续使用。

       不过,大家最好不要“一只脚踏两只船”,像这样就不好:

       // /* 语句1;

       语句2;

       */

       语句3;

       原先用“/*”和“*/”注释掉语句1和语句2,现在不小心又加上“//”,出错了。因为预处理器一看见“//”就不管三七二十一把“///* 语句1;”全部删除掉,结果又留下一个“*/”没有处理。

       结束本节之前,再讨论一个有趣的问题。

       有些敏感的读者已经坐不住了:那万一我想在字符串里包含“//”之类的注释符怎么办?譬如我要在屏幕上显示这么一行:

       we have a // in this line.

       能够这样写吗:

       printf(“we have a // in this line./n”);

       答案是可以的,只要记住三条原则:

       #1 字符串里面的注释符不起注释作用;

       #2 注释符里的双引号不起标识字符串的作用;

       #3 如果情况混乱则从头找起。

       例如:

       printf(“we have /* and */ here.”);

       则根据原则#1,最后打印出来的字符串不会缺少“/* and */”这部分。

       // “This line is a comment.”

       由原则#2,可以肯定这一行会被注释掉。

       /* “ */ “ */

       你可能这样想,第一个“*/”在双引号里面,噢,它不起注释作用,所以这一行被完全注释掉。

       不是的。在这么“恶劣”的环境下,我们要找出最先出现的符号是注释符还是双引号,在这个例子里,注释符最先带头,所以根据原则#2,双引号不起任何作用,当预处理器碰到第一个“*/”时就认为注释结束,预处理的结果是上面这一行语句最后剩下:

       “ */

       另:

       其实C/C++程序员可以使用预处理指令实现嵌套注释:

       语句1;

              #if 0

                     语句2;

                            #if 0

                                   语句3;

                            #endif

                     语句4;

              #endif

       语句5;

       因为预处理器在分析预处理指令时不仅进行词法分析,还进行语法分析,这就比使用“/*”和“*/”高级,后者仅仅涉及词法分析

C++ 注释

阅读数 92

C++ 注释程序的注释是解释性语句,您可以在C++代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C++支持单行注释和多行注释。注释中的所有字符会被C++编译器忽略。C++注释以/*开始,以*/终止。例如:/*这是注释*//*C++注释也可以*跨行*/注释也能以//开始

博文 来自: Richard__Ting

C++注释

阅读数 80

C++ 注释程序的注释是解释性语句,您可以在C++代码中包含注释,这将提高源代码的可读性。所有的编程语言都允许某种形式的注释。C++支持单行注释和多行注释。注释中的所有字符会被C++编译器忽略。C++注释以/*开始,以*/终止。例如:/*这是注释*//*C++注释也可以*跨行*/注释也能以//开始,直到行末为止。例如:实例#include&lt;iostrea...

博文 来自: gbbacqkl

c++的注释

阅读数 393

多行注释的时候使用/*...//*/这样假如要将这段代码还原的时候只需要在注释的第一行多加一个/即可取消注释。

博文 来自: meteor1113

C++注释

阅读数 567

1.文件注释/** *@file        Test.cpp *@author      张三 *@version     0.1 *@date        20090928 *@brief       日期处理类 *@details     对日期包装的处理 *  *@history */2.类注释/** 

博文 来自: hqh45

C++注释

阅读数 425

一、程序说明/**\file:CannyDetect.cpp*\brief:金属外边的检测,并将边缘点保存为txt**\详细概述:canny边缘检测算法,去燥、非极大值抑制、双阈值*ofstream用于保存数据到txt**\author:Aaron|Email:joeaaron007@gmail.com*\version1.0*\date:2016/

博文 来自: lxy_2011
没有更多推荐了,返回首页