大厂代码规范

news/2025/1/15 15:42:18/文章来源:https://www.cnblogs.com/llydbk/p/18404384

在选择成为计算机类软件工程专业的学生后,我便与代码有了紧密的联系,在写代码的同时,每个人的习惯都不同,所以也会形成自己的代码特点,而通过在网络上查找资料,我也了解了一些大厂的代码规范。大厂代码规范可以提升代码质量,一致的代码风格、命名约定和编程习惯能够减少错误发生的概率,提升代码的可读性和可维护性。在大规模项目中,这尤为重要,因为任何微小的错误都可能引发连锁反应。还能够促进团队协作,当团队成员遵循相同的代码规范时,他们可以更轻松地理解和修改彼此的代码,从而减少沟通成本,提升协作效率。大厂代码规范往往基于广泛接受的行业标准和最佳实践,这使得项目代码更容易被其他团队或开发者理解和接手,增强了项目的可移植性和可扩展性。

接下来是我查询到的大厂代码规范的核心要素
①命名规范:一些称谓尽量少用ABC代替 多使用一些有针对意义的词来代替。名字过于简单会难以区分为修改代码造成不必要的麻烦。而且起名不宜过长,过长的称谓不容易确认而且容易出错。一般遵循:作用域越大,名字越长,作用域越小,名字越短。
变量命名:采用描述性且简洁的命名方式,遵循驼峰命名法(CamelCase)或小写加下划线(snake_case),具体取决于项目或语言约定。
函数命名:明确表达函数的功能,对于返回布尔值的函数,常以is、has、can等前缀开头。
类与接口命名:使用大驼峰命名法(PascalCase),清晰区分类型与实例。
另外,起名不要带有歧义,要考虑到以后看见这个称谓自己或其他人会不会造成误解从而影响修改,尽量不使用有特殊含义的字母。

②编码风格
缩进与空格:统一使用空格或制表符进行缩进,并明确每级缩进的宽度。必要的空行和缩进有助于代码的美观清晰易懂,若一个代码块之间无空行和缩进,代码将会较难识别,并且不容易修改。
大括号风格:遵循K&R风格、Allman风格或其他团队约定的风格。
注释与文档:为复杂逻辑、关键算法及公开API编写清晰、准确的注释和文档。这样可以让代码有比较良好的可读性,而且必要的地方需要加上注释。代码不单单是给自己看也是给别人看的,大家读得懂自己的代码可以更好地发现问题并一起解决从而提高编程效率。一般较复杂的循环程序或函数要适当添加注释 让自己更加愿意去修改代码。

③编程实践
代码复用:通过函数、模块、类等方式实现代码复用,避免重复造轮子。对于函数的调用,一般编写要遵循逐层优先级递减顺序。
错误处理:合理处理异常和错误,确保程序的健壮性和可恢复性。
性能优化:在不影响可读性和可维护性的前提下,对关键路径进行性能优化。

④版本控制
Git流程:遵循Feature Branch Workflow、Gitflow等版本控制流程,确保代码合并的有序和可追溯。
Commit规范:使用清晰的提交信息,如遵循Angular的Commit Message Convention,便于后续的代码审查和版本管理。

以上就是我了解到的相关的代码规范,希望在接下来的代码学习的日子里,可以逐渐向其靠拢。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/794439.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

公安网络信息体系能力分类

来源:中国电子科学研究院学报,《公安网络信息体系顶层设计》

轮胎充气压力 气压单位换算 All In One

轮胎充气压力 & 气压单位换算 All In One bar / psi 1 bar = 14.5 psi轮胎充气压力 & 气压单位换算 All In Onebar / psi气压单位换算 1 bar = 14.5 psi demos(🐞 反爬虫测试!打击盗版⚠️)如果你看到这个信息, 说明这是一篇剽窃的文章,请访问 https://www.cnblog…

【工具推荐】xxl-jobExploitGUI - xxl-job一键漏洞利用工具+一键getshll

工具介绍 xxl-jobExploitGUI实现了XXL-JOB默认accessToken权限绕过漏洞的单个检测、批量检测、一键反弹shell功能,后续会持续更新优化,添加POC检测等。 下载链接: 链接: https://pan.quark.cn/s/55ed00b1512d使用说明 单个检测批量检测 fofa语句: body="{\"code\…

电动自行车轮胎规格参数图解教程 All In One

电动自行车轮胎规格参数图解教程 All In One电动自行车轮胎规格参数图解教程 All In One电动车轮胎参数单位换算1 in / 1 英寸 => 2.54 cm / 2.54 厘米https://convertlive.com/zh/u/转换/英寸/自/厘米#10 轮胎参数 轮胎尺寸(英寸): 轮毂尺寸(英寸): 10in 轮胎宽度/断面宽度…

首发找大佬定制的 黑神话悟空内置修改器

无敌模式 无伤判定 无限生命 无限法力 无限气力 无限棍势各种几十个功能 选择游戏进程直接起飞 自己打气死了一直过不去 直接找大佬定制一个 不想让兄弟们受气了 不限速链接:https://pan.quark.cn/s/f4f826c88f1d本文来自博客园,作者:Mr小扎仙森,转载请注明原文链接:http…

【工具推荐】TPscan (最新版本) - 一键ThinkPHP漏洞检测getshell

工具介绍 一键ThinkPHP漏洞检测,基于Python3,一键getshell 下载链接: 链接: https://pan.quark.cn/s/ff51139a5ace使用说明看着就真的看着,不学就真的5

强制删除PG数据库

删除数据是否显示: 有会话正在使用数据库: 解决: 一、查看谁在使用此数据库:SELECT * FROM pg_stat_activity WHERE usename = user where datname = your_database_name; 这将返回当前用户的所有活跃连接的详细信息。 二、如果可以最好先把占用的会话关掉后再删除 三、强…

训练框架技术序列一:Megtron-LLM架构源码

本文章涉及的Megatron-llm的XMind思维导图源文件和PDF文件,可在网盘下载: https://pan.baidu.com/s/1xRZD-IP95y7-4Fn0C_VJMg 提取码: qxff一、引言 Megatron-Core 是一个基于 PyTorch 的开源库,专为在 NVIDIA GPU 上高效训练大型语言模型(LLMs)而设计。它提供了一系列 GP…

KernelWarehouse:英特尔开源轻量级涨点神器,动态卷积核突破100+ | ICML 2024

动态卷积学习n个静态卷积核的线性混合,加权使用它们输入相关的注意力,表现出比普通卷积更优越的性能。然而,它将卷积参数的数量增加了n倍,因此并不是参数高效的。这导致不能探索n>100的设置(比典型设置n<10大一个数量级),推动动态卷积性能边界提升的同时享受参数的…

小集训 CSP-S 模拟赛

DAY 1 A.喜剧的迷人之处在于 小思维题不必细讲 B. 镜中的野兽 状压+容斥 $ gcd (x) + lcm(x) = m $ ,可以得知 $ gcd(x) $ 一定是 m 的因子,那么就可以枚举 $ gcd(x) $ 和 $ lcm(x) $。 对于已经确定的一对 $ gcd (x) 和 lcm(x) $ ,将他们进行质因数分解,写成 $ \prod{p_{…

从STM32的定时器到Linux上的时间相关服务

难题:在baremetal上实现按钮点击、长按事件 起因是因为我想用stm32加几个按钮只做一个我自己的控制器,我可以通过按钮执行一些功能。 硬件是如何和CPU通信的呢?CPU上支出几个GPIO引脚,这些引脚可以配置为输入模式和输出模式,并且都有两种状态——高电平和低电平。硬件连接…

自定义界面扫码,满足应用个性化定制需求

二维码识别技术已经成为我们日常生活中不可或缺的一部分,广泛应用于支付、交通、餐饮、生活服务以及智能家居等领域。它不仅是移动应用的重要流量入口,更是连接线上线下世界的桥梁。 不同的App在扫码界面的设计上各展其特色,从页面元素到交互方式,都体现了开发者对用户体验…