高质量C++编程指南学习笔记1-2章---thanks to林锐
2013-01-29 18:27
267 查看
看这本书主要是想规范下自己的编程习惯,所以看完只是开始,以后在实践中多运用。美好的期待。
简介:导读中说1-6章,难度低,重细节。7-11章是专题论述,多思考。那就先看前6章。再做附录的测试题。7-11一天看一章,不知道会不会太夸张。
看书规划调整版本1:今天看1-2章,明天3-4,后天5-6。
看书规划调整版本2:前六章复习到周一。
看书规划调整版本3:2月22号看完,25号要出差。
第一章
文件结构
每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明,称为头文件。另一个文件用于保存程序的实现,称为定义文件。
1、1版权和版本的声明
位于头文件和定义文件的开头,主要内容有:
1)
版权信息。
2)
文件名称,标识符,摘要。
3)
当前版本号,作者/修改者,完成日期。
4)
版本历史信息。
例子1-1:
/*
*Copyright (c) 2001,上海贝尔有限公司网络应用事业部
*All rights reserved.
*
*文件名称:filename.h
*文件标识:见配置管理计划书
*摘 要:简要描述本文件的内容
*
*当前版本:1.1
*作 者:输入作者(或修改者)名字
*完成日期:2001年7月20日
*
*取代版本:1.0
*原作者 :输入原作者(或修改者)名字
*完成日期:2001年5月10日
*/
1、2头文件的结构
头文件由三部分内容组成:
1)头文件开头处的版权和版本声明。
2)预处理块。
3)函数和类结构声明等。
遵循以下规则和建议:
【规则1-2-1】为防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
【规则1-2-2】用#include <>来引用标准库头文件,#include “”来引用非标准库头文件。
【建议1-2-1】头文件中只存放声明而不存放定义。
【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现像extern int value这类声明。
假设头文件名称为graphics.h,头文件结构示例1-2:
//版本和版权声明参见示例1-1,此处省略
#ifndef GRAPHICS_H //防止graphics.h被重复引用
#define GRAPHICS_H
#include <maht.h> //引用标准库的头文件
#include “myheader.h” //引用非标准库的头文件
void Function1(); //全局函数声明
class Box //类结构声明
{
}
#endif
1、3定义文件的结构
定义文件有三部分内容:
1)
定义文件开头处的版权和版本声明(参见示例1-1)。
2)
对一些头文件的引用。
3)
程序的实现体。
假设定义文件的名称为graphics.cpp,定义文件的结构参见示例1-3:
//版本和版权声明参见示例1-1,此处省略
#include “graphics.cpp” //引用头文件
//全局函数的实现体
void Function1(…)
{
……
}
//类成员函数的实现体
void Box::Draw(…)
{
……
}
1、4头文件的作用
1)通过头文件来调用库功能。很多场合,源代码不便公布,仅提供头文件和二进制的库即可。用户只需按照头文件中的接口声明来调用库功能。
2)头文件能加强类型安全检查。若某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误。
1、5目录结构
若头文件数目较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。如可将头文件保存于include目录,定义文件保存于source目录(可是多级目录)。
若某些头文件是私有的,它不被用户程序直接引用,则没必要公开其“声明”。为加强信息隐藏,这些私有头文件可和定义文件存放于同一目录。
总结:本章讲文件结构,先去理解文件结构是什么。从第一段了解到文件结构由头文件和定义文件组成。那接下来肯定是讲解头文件和定义文件了。头文件和定义文件的共性,作者先单独拿出来讲。后分开各自讲解。头文件作用单独讲,主要是当时很多语言没有头文件的概念。最后讲了目录结构,这个该是从实践中得知的吧。
第二章 程序的版式
版式会影响可读性。程序的版式追求清晰、美观。
2、1空行
空行起着分隔程序段落的作用。
【规则2-1-1】在每个类声明后、每个函数定义结束后都要加空行。
【规则2-1-2】在一个函数体内,逻辑上密切相关的语句之间不加空行,其他地方加。
2、2代码行
【规则2-2-1】一行代码只做一件事,如只定义一个变量,或只写一条语句。
【规则2-2-2】if、for、while、do等语句各自占一行,执行语句不得紧随其后。不论执行语句有多少都要加{}。
【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)。
2、3代码行内的空格
【规则2-3-1】关键字后留空格。如if、for、while等后留个空格再跟’(’。
【规则2-3-2】函数名后不要留空格,紧跟左括号’(’,以与关键字区别。
【规则2-3-3】’(’向后紧跟,’)’、’,’、’;’向前紧跟,紧跟出不留空格。
【规则2-3-4】’,’之后留空格,如Function(x, y, z)。若’;’不是一行的结束符号,其后留空格,如for(initializition;
condition; update)。
【规则2-3-5】赋值操作符、比较操作符、算术操作符、裸机操作符、位操作符等二元操作符的前后应当加空格。
【规则2-3-6】一元操作符如”!”、”~”、””、”++”、”&”等前后不加空格。
【规则2-3-7】像”[]”、”.”、”->”这类操作符前不加空格。
【建议2-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可是当去掉些空格。如for(int i=0;
i<10; i++)和if((a<=b) && (c<=d))。
2、4对齐
【规则2-4-1】程序的分界符’{’和’}’应独占一行且位于同一列,同时与引用它们的语句左对齐。
【规则2-4-1】{}之内的代码块在’{’右边数格处左对齐。
2、5长行拆分
【规则2-5-1】代码行最大产度宜控制在70-80个字符以内。
【规则2-5-2】长表达式要求在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
2、6修饰符的位置
【规则2-6-1】应当将修饰符*和&紧靠变量名。如int *x, y; //x与y不愿分行定义时,y不会被误解为指针。
2、7注释
【规则2-7-1】注释是对代码的“提示”,而不是文档,不可过多,应准确、易懂。
【规则2-7-2】边写代码边注释,修改代码同时修改相应的注释。
【规则2-7-3】注释的位置应与被描述的代码相邻,可放在代码的上方或右方,不可放在下方。
【规则2-7-4】当代码较长,特别是有多重嵌套时,应在一些段落的结束处加注释。
2、8类的版式
类的版式主要有两种方式:
1)将private类型数据写前面,而将public类型的函数写后面。这种版式主张类的设计“以数据位中心”,重点关注类的内部结构。
2)将public类型函数写签前面,而将private类型数据写后面。这种版式主张类的设计“以行为为中心”,重点关注类该提供什么接口。建议采用此方式----不仅让自己在设计类时思路清晰,且方便别人阅读。
总结:程序的版式,怎么叫好,怎么叫不好,作者给出定义:清晰,美观。怎么叫清晰,怎么叫美观呢。首先应该是风格的统一,其次是美观。那就先讨论风格。风格不就是代码的格式喽。代码的格式,总得知道代码都是什么类型吧。大概就是变量、函数、类、关键字、空格、空行,可别忘了注释哈,刚开始一直纠结注释写代码上面还是下面。还有‘{}’哈。
简介:导读中说1-6章,难度低,重细节。7-11章是专题论述,多思考。那就先看前6章。再做附录的测试题。7-11一天看一章,不知道会不会太夸张。
看书规划调整版本1:今天看1-2章,明天3-4,后天5-6。
看书规划调整版本2:前六章复习到周一。
看书规划调整版本3:2月22号看完,25号要出差。
第一章
文件结构
每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明,称为头文件。另一个文件用于保存程序的实现,称为定义文件。
1、1版权和版本的声明
位于头文件和定义文件的开头,主要内容有:
1)
版权信息。
2)
文件名称,标识符,摘要。
3)
当前版本号,作者/修改者,完成日期。
4)
版本历史信息。
例子1-1:
/*
*Copyright (c) 2001,上海贝尔有限公司网络应用事业部
*All rights reserved.
*
*文件名称:filename.h
*文件标识:见配置管理计划书
*摘 要:简要描述本文件的内容
*
*当前版本:1.1
*作 者:输入作者(或修改者)名字
*完成日期:2001年7月20日
*
*取代版本:1.0
*原作者 :输入原作者(或修改者)名字
*完成日期:2001年5月10日
*/
1、2头文件的结构
头文件由三部分内容组成:
1)头文件开头处的版权和版本声明。
2)预处理块。
3)函数和类结构声明等。
遵循以下规则和建议:
【规则1-2-1】为防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
【规则1-2-2】用#include <>来引用标准库头文件,#include “”来引用非标准库头文件。
【建议1-2-1】头文件中只存放声明而不存放定义。
【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现像extern int value这类声明。
假设头文件名称为graphics.h,头文件结构示例1-2:
//版本和版权声明参见示例1-1,此处省略
#ifndef GRAPHICS_H //防止graphics.h被重复引用
#define GRAPHICS_H
#include <maht.h> //引用标准库的头文件
#include “myheader.h” //引用非标准库的头文件
void Function1(); //全局函数声明
class Box //类结构声明
{
}
#endif
1、3定义文件的结构
定义文件有三部分内容:
1)
定义文件开头处的版权和版本声明(参见示例1-1)。
2)
对一些头文件的引用。
3)
程序的实现体。
假设定义文件的名称为graphics.cpp,定义文件的结构参见示例1-3:
//版本和版权声明参见示例1-1,此处省略
#include “graphics.cpp” //引用头文件
//全局函数的实现体
void Function1(…)
{
……
}
//类成员函数的实现体
void Box::Draw(…)
{
……
}
1、4头文件的作用
1)通过头文件来调用库功能。很多场合,源代码不便公布,仅提供头文件和二进制的库即可。用户只需按照头文件中的接口声明来调用库功能。
2)头文件能加强类型安全检查。若某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误。
1、5目录结构
若头文件数目较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。如可将头文件保存于include目录,定义文件保存于source目录(可是多级目录)。
若某些头文件是私有的,它不被用户程序直接引用,则没必要公开其“声明”。为加强信息隐藏,这些私有头文件可和定义文件存放于同一目录。
总结:本章讲文件结构,先去理解文件结构是什么。从第一段了解到文件结构由头文件和定义文件组成。那接下来肯定是讲解头文件和定义文件了。头文件和定义文件的共性,作者先单独拿出来讲。后分开各自讲解。头文件作用单独讲,主要是当时很多语言没有头文件的概念。最后讲了目录结构,这个该是从实践中得知的吧。
第二章 程序的版式
版式会影响可读性。程序的版式追求清晰、美观。
2、1空行
空行起着分隔程序段落的作用。
【规则2-1-1】在每个类声明后、每个函数定义结束后都要加空行。
【规则2-1-2】在一个函数体内,逻辑上密切相关的语句之间不加空行,其他地方加。
2、2代码行
【规则2-2-1】一行代码只做一件事,如只定义一个变量,或只写一条语句。
【规则2-2-2】if、for、while、do等语句各自占一行,执行语句不得紧随其后。不论执行语句有多少都要加{}。
【建议2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)。
2、3代码行内的空格
【规则2-3-1】关键字后留空格。如if、for、while等后留个空格再跟’(’。
【规则2-3-2】函数名后不要留空格,紧跟左括号’(’,以与关键字区别。
【规则2-3-3】’(’向后紧跟,’)’、’,’、’;’向前紧跟,紧跟出不留空格。
【规则2-3-4】’,’之后留空格,如Function(x, y, z)。若’;’不是一行的结束符号,其后留空格,如for(initializition;
condition; update)。
【规则2-3-5】赋值操作符、比较操作符、算术操作符、裸机操作符、位操作符等二元操作符的前后应当加空格。
【规则2-3-6】一元操作符如”!”、”~”、””、”++”、”&”等前后不加空格。
【规则2-3-7】像”[]”、”.”、”->”这类操作符前不加空格。
【建议2-3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可是当去掉些空格。如for(int i=0;
i<10; i++)和if((a<=b) && (c<=d))。
2、4对齐
【规则2-4-1】程序的分界符’{’和’}’应独占一行且位于同一列,同时与引用它们的语句左对齐。
【规则2-4-1】{}之内的代码块在’{’右边数格处左对齐。
2、5长行拆分
【规则2-5-1】代码行最大产度宜控制在70-80个字符以内。
【规则2-5-2】长表达式要求在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
2、6修饰符的位置
【规则2-6-1】应当将修饰符*和&紧靠变量名。如int *x, y; //x与y不愿分行定义时,y不会被误解为指针。
2、7注释
【规则2-7-1】注释是对代码的“提示”,而不是文档,不可过多,应准确、易懂。
【规则2-7-2】边写代码边注释,修改代码同时修改相应的注释。
【规则2-7-3】注释的位置应与被描述的代码相邻,可放在代码的上方或右方,不可放在下方。
【规则2-7-4】当代码较长,特别是有多重嵌套时,应在一些段落的结束处加注释。
2、8类的版式
类的版式主要有两种方式:
1)将private类型数据写前面,而将public类型的函数写后面。这种版式主张类的设计“以数据位中心”,重点关注类的内部结构。
2)将public类型函数写签前面,而将private类型数据写后面。这种版式主张类的设计“以行为为中心”,重点关注类该提供什么接口。建议采用此方式----不仅让自己在设计类时思路清晰,且方便别人阅读。
总结:程序的版式,怎么叫好,怎么叫不好,作者给出定义:清晰,美观。怎么叫清晰,怎么叫美观呢。首先应该是风格的统一,其次是美观。那就先讨论风格。风格不就是代码的格式喽。代码的格式,总得知道代码都是什么类型吧。大概就是变量、函数、类、关键字、空格、空行,可别忘了注释哈,刚开始一直纠结注释写代码上面还是下面。还有‘{}’哈。
相关文章推荐
- 高质量C++编程指南学习笔记第10章---thanks to林锐
- 高质量C++编程指南学习笔记第9章---thanks to林锐
- 高质量C++编程指南学习笔记第11章---thanks to林锐
- 高质量C++编程指南学习笔记5-6章---thanks to林锐
- 高质量C++编程指南学习笔记第7章---thanks to林锐
- 高质量C++编程指南学习笔记3-4章---thanks to林锐
- 高质量C++编程指南学习笔记第8章---thanks to林锐
- 高质量C++编程指南学习笔记
- 编程中国之高质量C++或C编程指南学习笔记
- 【C】【笔记】高质量C++编程指南
- 高质量C++编程指南 》学习重点四
- 《 高质量C++编程指南 》学习重点五
- 《 高质量C++编程指南 》学习重点六
- 《 高质量C++编程指南 》学习重点七
- 《 高质量C++编程指南 》学习重点八
- 高质量C&C++编程指南---笔记
- 《 高质量C++编程指南 》学习重点九
- 高质量C++编程指南笔记1:文件结构
- 高质量C++编程指南学习小结
- 初读高质量C和C++编程指南笔记