首页 > 编程语言 >高质量C/C++编程指南总结(二)—— 文件版式

高质量C/C++编程指南总结(二)—— 文件版式

时间:2024-07-14 12:40:44浏览次数:14  
标签:语句 空格 代码 编程 C++ 注释 关键字 操作符 版式

1. 空行

  • 在每个类声明之后、每个函数定义结束之后都要加空行。
  • 在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

2. 代码行

  • 一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
  • if、 for、 while、 do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
  • 在定义变量的同时初始化该变量。

3. 代码行内的空格

  • 关键字之后要留空格。

像 const、 virtual、 inline、 case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、 for、 while 等关键字之后应留一个空格再跟左括号‘(’ ,以突出关键字。

  • 函数名之后不要留空格,紧跟左括号‘(’ ,以与关键字区别。
  • (’向后紧跟, ‘)’ 、 ‘, ’ 、 ‘ ;’向前紧跟,紧跟处不留空格。
  • , ’之后要留空格。

如 Function(x, y, z)。如果‘ ;’不是一行的结束符号,其后要留空格,如 for (initialization; condition; update)。

  • 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“ =”、 “ +=” “ >=”、 “ <=”、 “ +”、 “ *”、 “ %”、 “ &&”、 “ ||”、 “ <<” ,“ ^”等二元操作符的前后应当加空格。
  • 一元操作符如“ !”、“ ~”、“ ++”、“ --”、“ &”(地址运算符)等前后不加空格。
  • 像“[]”、 “ .”、 “ ->”这类操作符前后不加空格。
  • 对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格。

如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

4. 对齐

  • 程序的分界符‘ {’和‘ }’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
  • { }之内的代码块在‘ {’右边数格处左对齐。

5. 长行拆分

  • 代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
  • 长表达式要在低优先级操作符处拆分成新行, 操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

6. 修饰符的位置

  • 将修饰符 * 和 & 紧靠变量名。

7. 注释

  • 注释是对代码的“提示”,而不是文档。注释花样要少。
  • 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
  • 注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
  • 避免在注释中使用缩写,特别是不常用缩写。
  • 注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
  • 当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

8. 类的板式

  • 建议采用“以行为为中心”的书写方式编写类。
    • 将 public 类型的函数写在前面,而将 private 类型的数据写在后面,采用这种版式的程序员主张类的设计“以行为为中心”,重点关注的是类应该提供什么
      样的接口(或服务)。
    • 将 private 类型的数据写在前面, 而将 public 类型的函数写在后面, 采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。

标签:语句,空格,代码,编程,C++,注释,关键字,操作符,版式
From: https://www.cnblogs.com/moyu557/p/18301354

相关文章

  • 高质量C/C++编程指南总结(一)—— 文件结构
    1.版权和版本的声明应位于头文件和定义文件的开头,主要包括的内容有:版本信息。文件名称、文件标识、摘要。当前的版本号、作者/修改者、完成日期。历史版本信息(取代版本、原作者、完成日期)。2.头文件结构为了防止头文件被重复引用,应当使用ifndef/define/endif结构产生......
  • 深入解析C++中的特殊成员函数:构造函数、析构函数、拷贝构造函数与赋值操作符
    深入解析C++中的特殊成员函数:构造函数、析构函数、拷贝构造函数与赋值操作符在C++编程的浩瀚宇宙中,构造函数、析构函数、拷贝构造函数和赋值操作符是构成对象生命周期和行为的四大基石。它们各自扮演着不可或缺的角色,确保了对象从创建到销毁,从复制到赋值的整个过程既安全又......
  • OpenFlow 是一个网络通信协议,它允许网络管理员通过中央控制器(如 OpenFlow 控制器)来编
    OpenFlow是一个网络通信协议,它允许网络管理员通过中央控制器(如OpenFlow控制器)来编程定义网络中的数据包转发行为。OpenFlow协议通常用于软件定义网络(SDN)架构中,其中网络控制平面与数据转发平面是分离的。在Python中,直接编写与OpenFlow交换机交互的代码通常涉及使用......
  • C++查找最大元素与s.find()和s.insert()
    题目描述:m老师在学习字符串的时候,对于字符串中的最大字符很感兴趣。因此他想对于输入的每个字符串,查找其中的ASCII码最大字母,在该字母后面插入字符串“(max)”。输入描述输入数据包括多个测试实例,第一行输入一个整数n表示样例个数。每个实例由一行长度不超过100的字符串......
  • C++ STL常用容器之vector(顺序容器)
    文章目录前言一、vector的介绍1.1vector的优点1.2vector的缺点1.3使用场景二、vector常用的操作2.1创建、初始化以及遍历容器2.2查询容器大小2.3访问容器中的元素2.4往容器中添加元素2.5删除容器中的元素2.6清空容器中的元素总结前言本文主要介绍C++STL......
  • C++ //练习 14.44 编写一个简单的桌面计算器使其能处理二元运算。
    C++Primer(第5版)练习14.44练习14.44编写一个简单的桌面计算器使其能处理二元运算。环境:LinuxUbuntu(云服务器)工具:vim 代码块/************************************************************************* >FileName:ex14.44.cpp >Author: >Mail: >C......
  • Android C++系列:Linux常用函数和工具
    1.时间函数1.1文件访问时间#include<sys/types.h>#include<utime.h>intutime(constchar*name,conststructutimebuf*t);返回:若成功则为0,若出错则为-1如果times是一个空指针,则存取时间和修改时间两者都设置为当前时间;如果times是非空指针,则存取时......
  • Android C++系列:Linux进程间关系
    1.终端在UNIX系统中,用户通过终端登录系统后得到一个Shell进程,这个终端成为Shell进程的控制终端(ControllingTerminal),在前面文章我们说过,控制终端是保存在PCB中的信息,而我们知道fork会复制PCB中的信息,因此由Shell进程启动的其它进程的控制终端也是这个终端。默认情况......
  • C++ //练习 15.5 定义你自己的Bulk_quote类。
    C++Primer(第5版)练习15.5练习15.5定义你自己的Bulk_quote类。环境:LinuxUbuntu(云服务器)工具:vim 代码块/************************************************************************* >FileName:ex15.3.cpp >Author: >Mail: >CreatedTime:Fri12J......
  • C++ //练习 15.7 定义一个类使其实现一种数量受限的折扣策略,具体策略是:当购买书籍的数
    C++Primer(第5版)练习15.7练习15.7定义一个类使其实现一种数量受限的折扣策略,具体策略是:当购买书籍的数量不超过一个给定的限量时享受折扣,如果购买量一旦超过了限量,则超出的部分将以原价销售。环境:LinuxUbuntu(云服务器)工具:vim 代码块/**************************......