条款4:尽量使用c++风格的注释

转载 2006年05月29日 21:35:00

条款4:尽量使用c++风格的注释

 

旧的c注释语法在c++里还可以用,c++新发明的行尾注释语法也有其过人之处。例如下面这种情形:

 

if ( a > b ) {
	// int temp = a;	// swap a and b
	// a = b;
	// b = temp;
}

假设你出于某种原因要注释掉这个代码块。从软件工程的角度看,写这段代码的程序员也做得很好,他最初的代码里也写了一个注释,以解释代码在做什么。用c++形式的句法来注释掉这个程序块时,嵌在里面的最初的注释不受影响,但如果选择c风格的注释就会发生严重的错误:

 

if ( a > b ) {
	/*	int temp = a;  /* swap a and b */
		a = b;
		b = temp;
	*/
}

请注意嵌在代码块里的注释是怎么无意间使本来想注释掉整个代码块的注释提前结束的。

c风格的注释当然还有它存在的价值。例如,它们在c和c++编译器都要处理的头文件中是无法替代的。尽管如此,只要有可能,你最好尽量用c++风格的注释。

值得指出的是,有些老的专门为c写的预处理程序不知道处理c++风格的注释,所以象下面这种情形时,事情就不会象预想的那样:

 

#define light_speedp 3e8	// m/sec (in a vacuum)

对于不熟悉c++的预处理程序来说,行尾的注释竟然成为了宏的一部分!当然,正象条款1所说的那样,你无论如何也不会用预处理来定义常量的。

Effective C++:条款4:尽量使用c++风格的注释

旧的c注释语法在c++里还可以用,c++新发明的行尾注释语法也有其过人之处。例如下面这种情形: if ( a > b ) { // int temp = a; // swap a and b /...
  • wangqiulin123456
  • wangqiulin123456
  • 2012年12月02日 09:50
  • 936

Effective C++条款4:尽量使用c++风格的注释

 条款4:尽量使用c++风格的注释旧的c注释语法在c++里还可以用,c++新发明的行尾注释语法也有其过人之处。例如下面这种情形:if ( a > b ) {// int temp = a; // sw...
  • ipromiseu
  • ipromiseu
  • 2009年05月08日 22:43
  • 497

条款4:尽量使用c++风格的注释

即尽量用// 而不是/* */旧的c注释语法在c++里还可以用,c++新发明的行尾注释语法也有其过人之处。例如下面这种情形: if ( a > b ) {        // int temp = a...
  • developinglife
  • developinglife
  • 2011年06月30日 12:24
  • 279

C注释风格转化为C++风格注释

C转C++可能遇到的问题: //1.一般情况 /* int i = 0; */ // 2.换行问题 /* int i = 0; */ int j = 0; ...
  • LF_2016
  • LF_2016
  • 2016年05月11日 12:40
  • 1189

注释转换(C注释风格-C++注释风格)

注释一般来讲有分为两种: 一是单行注释:直接在该行需要注释的地方加上”//”就行 如:// int a=0; int b=0; //定义一个变量 另外还有一种是多行同时注释(不能...
  • dove1202ly
  • dove1202ly
  • 2017年07月30日 12:31
  • 296

5.4 C++风格的注释

5.4      C++风格的注释 5.4.1    概述 C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’ 其他地方其实与JavaDoc的风格类似,只是C++风格不用 ...
  • netlinux
  • netlinux
  • 2012年06月20日 23:56
  • 5141

C++风格的注释

5.4      C++风格的注释 5.4.1    概述 C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’ 其他地方其实与JavaDoc的风格类似,只是C++风格不用 ...
  • hanghangde
  • hanghangde
  • 2016年03月07日 17:45
  • 1742

使用DOXYGEN风格注释

什么是DoxyGen :这是一款可以根据约定好的注释,自动生成说明文档的软件(插件)。此软件(插件)完全免费。 为什么选择DoxyGen: 源代码编写者,仅需要简单的了解了DOXYGen的注释风格,...
  • zvvzxzko2006
  • zvvzxzko2006
  • 2014年12月30日 09:42
  • 877

C++注释妙用

从前曾经看过一种代码开关//*/   codeSegement1;//*/改动第一行就成了 /*/   codeSegement1;//*/后来,在我的实践中,我又发现了更妙的用法代码切换开关//--...
  • virm
  • virm
  • 2005年03月07日 22:01
  • 1711

C++标准注释原则 - 基于doxygen的C++注释

标注总述 下载国外的源代码,往往能看到附带的说明文档,文档都有详细的说明,大部分文档都可以通过doxygen这个跨平台软件生成,doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成...
  • czyt1988
  • czyt1988
  • 2013年05月08日 21:30
  • 11423
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:条款4:尽量使用c++风格的注释
举报原因:
原因补充:

(最多只允许输入30个字)