博客
关于我
C编程规范整理
阅读量:499 次
发布时间:2019-03-07

本文共 1461 字,大约阅读时间需要 4 分钟。

  • 只有当函数只有10行甚至更少时才会将其定义为内联函数(inline function)。当函数体比较小的时候,内联该函数可以令目标代码更加高效。内联那些包含循环switch语句的函数是得不偿失的。如果一个inline函数会在多个源文件中被用到,那么必须把它定义在 .h头文件 中。

  • 内联函数只是向编译器发出一个请求,编译器可以选择忽略这个请求。

  • 定义函数时,参数顺序为:输入参数在前,输出参数在后。这一点并不是必须遵循的规则,输入/输出两用参数(通常是类/结构体变量)混在其中,会使得规则难以遵循。

  • 包含文件的名称及次序:C库、C++库、其他库的.h、项目内的.h。

  • 编写短小函数。长函数有时是恰当的,因此对于函数长度并没有严格限制。如果函数超过40行,可以考虑在不影响程序结构的情况下将其分割一下。

  • const使用。强烈建议你在任何可以使用的情况下都要使用const。

  • 类型命名。类型命名每个单词以大写字母开头,不包含下划线:MyExcitingClass、MyExcitingEnumo。所有类型命名——类、结构体、类型定义(typedef)、枚举——使用相同约定。

  • 变量命名。变量名一律小写,单词间以下划线相连,类的成员变量以下划线结尾,如my_exciting_local_variab1e、my_exciting_meber_variab1e_。

  • 全局变量。可以以 g_ 或其他易与局部变量区分的标志为前缀。

  • 普通函数。大小写混合,函数名以大写字母开头,每个单词首字母大写,没有下划线:AddTab1eEntry()、DeleteUr1()。

  • 存取函数。存取函数要与存取的变量名匹配:set_my_exciting_member_variab1e() 。

  • 其他短小的内联函数名也可以使用小写字母,例如,在循环中调用这样的函数甚至都不需要缓存其值,小写命名就可以接受。

  • 枚举命名枚举值全部大写,单词间以下划线相连:MY_EXCITING_ENUM_VALUE。枚举名称属于类型,因此大小写混合:Ur1Tab1eErrors。

  • 宏命名。其命名像枚举命名—样全部大写、使用下划线。

  • 注意永远不要用自然语言翻译代码作为注释,要假设读你代码的人C/C++比你强。

  • TODO注释。对那些临时的、短期的解决方案,或已经够好但并不完美的代码使用TODO注释。后面括号里加上你的大名、邮件地址等,还可以加上冒号:,目的是可以根据统一的TODO格式进行查找:

  • 全局变量要有较详细的注释,包括对其功能、取值范围以及存取时注意事项等的说明。

  • 注释应放在其代码上方相邻位置右方,不可放在下面。如放于上方则需与其上面的代码用空行隔开,且与下方代码缩进相同。

  • 对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。

  • 避免在注释中使用缩写,除非是业界通用或子系统内标准化的缩写。

  • 注释应考虑程序易读及外观排版的因紊,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。对于有外籍员工的,由产品确定注释语言。

  • 文件头、函数头、全局常量变量、类型定义的注释格式采用工具可识别的格式(如doxygen)。

    在这里插入图片描述

  • 相对独立的程序块之间、变量说明之后必须加空行

  • 多个短语句(包括赋值语句)不允许写在同一行内,即一行只写一条语句。

  • 使用断言记录内部假设。不能用断言来检查运行时错误。

  • 确保所有字符串是以NULL结束。

    在这里插入图片描述

转载地址:http://kbscz.baihongyu.com/

你可能感兴趣的文章
Nginx配置实例-负载均衡实例:平均访问多台服务器
查看>>
Nginx配置文件nginx.conf中文详解(总结)
查看>>
Nginx配置负载均衡到后台网关集群
查看>>
ngrok | 内网穿透,支持 HTTPS、国内访问、静态域名
查看>>
NHibernate学习[1]
查看>>
NHibernate异常:No persister for的解决办法
查看>>
NIFI1.21.0_Mysql到Mysql增量CDC同步中_日期类型_以及null数据同步处理补充---大数据之Nifi工作笔记0057
查看>>
NIFI1.21.0_Mysql到Mysql增量CDC同步中_补充_更新时如果目标表中不存在记录就改为插入数据_Postgresql_Hbase也适用---大数据之Nifi工作笔记0059
查看>>
NIFI1.21.0_NIFI和hadoop蹦了_200G集群磁盘又满了_Jps看不到进程了_Unable to write in /tmp. Aborting----大数据之Nifi工作笔记0052
查看>>
NIFI1.21.0通过Postgresql11的CDC逻辑复制槽实现_指定表多表增量同步_增删改数据分发及删除数据实时同步_通过分页解决变更记录过大问题_02----大数据之Nifi工作笔记0054
查看>>
NIFI1.21.0通过Postgresql11的CDC逻辑复制槽实现_指定表或全表增量同步_实现指定整库同步_或指定数据表同步配置_04---大数据之Nifi工作笔记0056
查看>>
NIFI1.23.2_最新版_性能优化通用_技巧积累_使用NIFI表达式过滤表_随时更新---大数据之Nifi工作笔记0063
查看>>
NIFI从MySql中增量同步数据_通过Mysql的binlog功能_实时同步mysql数据_根据binlog实现数据实时delete同步_实际操作04---大数据之Nifi工作笔记0043
查看>>
NIFI从MySql中增量同步数据_通过Mysql的binlog功能_实时同步mysql数据_配置binlog_使用处理器抓取binlog数据_实际操作01---大数据之Nifi工作笔记0040
查看>>
NIFI从MySql中增量同步数据_通过Mysql的binlog功能_实时同步mysql数据_配置数据路由_实现数据插入数据到目标数据库_实际操作03---大数据之Nifi工作笔记0042
查看>>
NIFI从MySql中离线读取数据再导入到MySql中_03_来吧用NIFI实现_数据分页获取功能---大数据之Nifi工作笔记0038
查看>>
NIFI从MySql中离线读取数据再导入到MySql中_无分页功能_02_转换数据_分割数据_提取JSON数据_替换拼接SQL_添加分页---大数据之Nifi工作笔记0037
查看>>
NIFI从PostGresql中离线读取数据再导入到MySql中_带有数据分页获取功能_不带分页不能用_NIFI资料太少了---大数据之Nifi工作笔记0039
查看>>
nifi使用过程-常见问题-以及入门总结---大数据之Nifi工作笔记0012
查看>>
NIFI分页获取Mysql数据_导入到Hbase中_并可通过phoenix客户端查询_含金量很高的一篇_搞了好久_实际操作05---大数据之Nifi工作笔记0045
查看>>