简图记录-C语言编程规范:可读性、安全性、可移植性

本文主要是介绍简图记录-C语言编程规范:可读性、安全性、可移植性,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

简图记录学习~

前人已经有大量的资料可供我们参考,任何一家公司、部门、甚至是小组常常都会指定各种规范,个人提炼和总结规范如下

一、为什么要制定规范?

可读性需求:对命名、函数最大行数/复杂度 等进行约束,维护代码相可读性,使用统一风格更便于交流和理解。

降低bug率需求:通过强制一些写法降低bug率,如 内存的申请释放严格流程、数组字符串操作检查,类型转化等等。

模板经验传递:针对产品的特性,各个模块公共部分提供demo写法,或者犯错的地方加以说明提醒

可移植需求:对一些接口和数据结构加以限制,比如不允许直接调用linux内核原生接口等,防止和某种系统绑定

信息安全要求:对打印、警告、敏感信息和部分用词做出限制。

二、C语言常见编码规范

1、代码 基本/可读性 要求

命名准确无歧义:不要用拼音,建议使用完整的单词或者产品项目大范围认可的缩写;变量命名使用 (形+)名词,函数命名使用 动名词组合,避免使用数字编号除非逻辑上存在强相关。作用域越大命名越细。

变量职能单一:变量使用前进行合理初始化,禁止同一个变量在函数内部做不同的含义变量重复使用。变量大小注意系统栈约束,不要使用过大的栈变量。针对 全局变量 追加 前缀 标识。

宏定义注意保护:宏定义表达式或者函数,对参数要有完备的括号,多条语句的宏使用do while(0)保护,避免在宏中添加contiue、break、return等影响执行流的操作,非常容易异常处理流程 遗漏分支。

函数职能单一:一个函数只做一件事,避免重复和过长的代码段(如 非注释代码行<=200行),避免过高的嵌套深度(如 <=4),避免过高的圈复杂度(如 <=20),避免过大的扇出(如 <=7),避免过多的入参(如 <=5)避免过于频繁的直接引用全局变量(满天飞很危险),尽可能做到函数可重入。

2、代码安全性要求

入参检查完备:模块的入口应该做好完备的入参检查,特别时指针。

字符串/数组 操作谨慎:确保存储不定长字符串有足够空间,确保操作后字符串以'\0'结尾,优先使用定长操作函数 如strncpy替代strcpy。

内存操作谨慎:禁止使用未初始化内存,申请内存大小避免使用魔鬼数字而是优先用sizeof(struct xxx)或者显示的宏定义,如果需要计算size再申请必须校验大小,注意内存申请释放配对防止内存泄漏(特别时异常流程处理),注意释放内存后清空指针防止野指针出现。

整数计算谨慎:确保运算不会引起 溢出/截断(大转小)/除零错误,避免有无符号同时参与运算引起符号隐形转化。

文件操作谨慎:文件的创建一定要显示指定权限,文件的路径一定要进行校验,防止文件被替换攻击。

下标访越界校验:数组或者字串使用下标或者偏移引用时,必须确保操作过程不超过数组或者子串边界 引起 越界访问。

3、代码可移植性要求

避免直接引用原生接口:降低和系统耦合,建议使用产品统一适配层封装,这样在各个平台或者boot迁移时工作更小。

协议类数据注意字节对齐:协议类数据必须使用#program pack标准进行指定,防止编译器对齐优化影响排布。

大小端对齐要求:通讯类的数据结构需要注意大小端的转化处理。

32/64bit适配:虚拟地址类用指针保存,涉及物理地址传递时(如内核驱动模块)用64位防止截断(或者使用统一的数据结构封装,在不同的系统使用32/64定义)。不使用long类型(32位64位大小)

4、代码文件组织要求

.h只描述对外依赖:一个.c文件 对应的 .h应该只包含 .c对外暴露的接口和数据结构定义,不能把内部使用的函数和数据结构随意的定义的它的.h中。

.h明确单一职责:不允许搞god头文件,包含全部要使用的各种头文件或者全部声明,然后其他.c再去包含他,用着时候爽了,实际层次关系完全被破坏,不可维护。

.h包含方向稳定:上层模块可以包含底层被调用者的头文件,同级业务模块之间的头文件包含要审视。

.h要做到自包含:.h要能做到单独编译,a.c如果包含x.h,x.h中自己使用的数据结构应该全部要自己包含或者引用,不能让a.c在包含x.h之前必须再包含y.h(由于x.h中用到的部分数据结构x.h没有自己包含对应的.h)

.h自己要做宏保护防止重复包含:使用#ifndef XXXX define XXX /***代码***/ #endif 保护起来

三、何如学习和使用规范?

实际上往往只用通过实际coding过程的经验体会,我们才能够更深刻的体会规范的原因和好处

每个程序员的编程规范、编程风格往往都是一个逐渐形成完善的过程

想要形成良好的编程风格在收集大量编程规范后,一定要有自己的思考和总结,在运用中提炼出自己的风格

 

 

这篇关于简图记录-C语言编程规范:可读性、安全性、可移植性的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/241826

相关文章

通过Python脚本批量复制并规范命名视频文件

《通过Python脚本批量复制并规范命名视频文件》本文介绍了如何通过Python脚本批量复制并规范命名视频文件,实现自动补齐数字编号、保留原始文件、智能识别有效文件等功能,听过代码示例介绍的非常详细,... 目录一、问题场景:杂乱的视频文件名二、完整解决方案三、关键技术解析1. 智能路径处理2. 精准文件名

基于Python实现多语言朗读与单词选择测验

《基于Python实现多语言朗读与单词选择测验》在数字化教育日益普及的今天,开发一款能够支持多语言朗读和单词选择测验的程序,对于语言学习者来说无疑是一个巨大的福音,下面我们就来用Python实现一个这... 目录一、项目概述二、环境准备三、实现朗读功能四、实现单词选择测验五、创建图形用户界面六、运行程序七、

Spring Retry 实现乐观锁重试实践记录

《SpringRetry实现乐观锁重试实践记录》本文介绍了在秒杀商品SKU表中使用乐观锁和MybatisPlus配置乐观锁的方法,并分析了测试环境和生产环境的隔离级别对乐观锁的影响,通过简单验证,... 目录一、场景分析 二、简单验证 2.1、可重复读 2.2、读已提交 三、最佳实践 3.1、配置重试模板

在 Spring Boot 中使用异步线程时的 HttpServletRequest 复用问题记录

《在SpringBoot中使用异步线程时的HttpServletRequest复用问题记录》文章讨论了在SpringBoot中使用异步线程时,由于HttpServletRequest复用导致... 目录一、问题描述:异步线程操作导致请求复用时 Cookie 解析失败1. 场景背景2. 问题根源二、问题详细分

使用Go语言开发一个命令行文件管理工具

《使用Go语言开发一个命令行文件管理工具》这篇文章主要为大家详细介绍了如何使用Go语言开发一款命令行文件管理工具,支持批量重命名,删除,创建,移动文件,需要的小伙伴可以了解下... 目录一、工具功能一览二、核心代码解析1. 主程序结构2. 批量重命名3. 批量删除4. 创建文件/目录5. 批量移动三、如何安

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本

关于Spring @Bean 相同加载顺序不同结果不同的问题记录

《关于Spring@Bean相同加载顺序不同结果不同的问题记录》本文主要探讨了在Spring5.1.3.RELEASE版本下,当有两个全注解类定义相同类型的Bean时,由于加载顺序不同,最终生成的... 目录问题说明测试输出1测试输出2@Bean注解的BeanDefiChina编程nition加入时机总结问题说明

Go语言中三种容器类型的数据结构详解

《Go语言中三种容器类型的数据结构详解》在Go语言中,有三种主要的容器类型用于存储和操作集合数据:本文主要介绍三者的使用与区别,感兴趣的小伙伴可以跟随小编一起学习一下... 目录基本概念1. 数组(Array)2. 切片(Slice)3. 映射(Map)对比总结注意事项基本概念在 Go 语言中,有三种主要

C语言中自动与强制转换全解析

《C语言中自动与强制转换全解析》在编写C程序时,类型转换是确保数据正确性和一致性的关键环节,无论是隐式转换还是显式转换,都各有特点和应用场景,本文将详细探讨C语言中的类型转换机制,帮助您更好地理解并在... 目录类型转换的重要性自动类型转换(隐式转换)强制类型转换(显式转换)常见错误与注意事项总结与建议类型

Go语言利用泛型封装常见的Map操作

《Go语言利用泛型封装常见的Map操作》Go语言在1.18版本中引入了泛型,这是Go语言发展的一个重要里程碑,它极大地增强了语言的表达能力和灵活性,本文将通过泛型实现封装常见的Map操作,感... 目录什么是泛型泛型解决了什么问题Go泛型基于泛型的常见Map操作代码合集总结什么是泛型泛型是一种编程范式,允