首页 > 其他分享 >大厂代码规范

大厂代码规范

时间:2024-09-09 13:35:36浏览次数:12  
标签:缩进 代码 规范 大厂 遵循 命名

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

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

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

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

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

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

标签:缩进,代码,规范,大厂,遵循,命名
From: https://www.cnblogs.com/llydbk/p/18404384

相关文章

  • PHP毕业设计作品:基于PHP音乐网站音乐平台系统设计与实现开题报告和源代码成品
     博主介绍:黄菊华老师《Vue.js入门与商城开发实战》《微信小程序商城开发》图书作者,CSDN博客专家,在线教育专家,CSDN钻石讲师;专注大学生毕业设计教育和辅导。所有项目都配有从入门到精通的基础知识视频课程,学习后应对毕业设计答辩。项目配有对应开发文档、开题报告、任务书、P......
  • linux安装python3(源代码安装)
    相关软件安装python3安装源代码安装下载python3源码包比如说python3.9.10:https://www.python.org/ftp/python/3.9.10/Python-3.9.10.tar.xz#通过wget下载wgethttps://www.python.org/ftp/python/3.9.10/Python-3.9.10.tar.xz#进行源代码包的解压(xz使用J解压,gz使用......
  • 指令微调与参数微调的代码实践与分析
    文章目录指令微调的实验性分析LoRA代码实践与分析    指令微调的示例代码与预训练的代码高度一致,区别主要在于指令微调数据集的构建(SFTDataset)和序列到序列损失的计算(DataCollatorForSupervisedDataset)。以下代码展示了LLMBox和YuLan-Chat中指令微调......
  • 足浴行业在线预约小程序源码系统+支持拼团功能 带完整的安装代码包以及搭建部署教程
    系统概述在快节奏的现代生活中,人们对健康养生的需求日益增长,足浴行业作为传统养生方式之一,其市场需求也随之不断扩大。为了满足消费者日益增长的便捷性需求,一款集在线预约、拼团优惠于一体的足浴行业小程序源码系统应运而生。本文将详细介绍这款源码系统的系统概述、特色功能......
  • Typora Markdown 设定代码显示高度
    点击Typora的文件—>偏好设置–>外观–>打开主题文件夹–>改开对应的CSS文件添加CSS样式.md-fences{max-height:300px;overflow-y:auto;}效果作者:VipSoft......
  • 安卓版本python画一个太极图程序代码
    importturtleimportmathdefdraw_circle(color,radius,x,y):turtle.penup()turtle.goto(x,y)turtle.pendown()turtle.color(color)turtle.begin_fill()turtle.circle(radius)turtle.end_fill()defdraw_half_yin_yang(color,radius,x,y):turtle.penup()......
  • C++学习笔记(曾经我看不懂的代码2:基于范围的for循环、auto使用、stl容器、template模
    不知不觉c++程序设计:标准库已经看了一大半了,学到了很多,很多曾经在网上和在书上看到却看不懂的代码,在看完标准库中的大半内容以后,都能大致的理清代码的含义。代码模板一:for(auto&a:arr)1、基于范围的for循环:a为迭代变量,arr为迭代范围,&表示引用。写一个例子:#include<ios......
  • Axure的画图规范说明
    Axure的画图规范说明自定义网页整体尺寸:1366x768;色值:# F8F9FD顶部一级导航:1366x48;色值:# 1D8FFF左右布局,左侧边导航:768x194;色值:# 191A23侧边导航栏宽高:194x768左侧一级菜单宽高:194x40/边距:16,字号:14,色值:#FFFFFF,图标:14x14,二级导航宽194w,高40h,一二级菜单文字相差一个文......
  • Java基础—运算符篇(从0到1完整详解,附有代码+案例)
    文章目录运算符分类:2.1.算术运算符2.1.1基本算数运算2.1.2复合算数运算2.1.3类型转换2.1.4“+”的三种情况2.2自增自减运算符2.3赋值运算符2.4关系运算符2.5逻辑运算符2.6短路逻辑运算符2.7三元运算符2.8运算的优先级运算符分类:赋值运算符:=算术运算符:+-......
  • 基于Oracle数据库的网络教学系统的开发和应用论文+任务书+翻译+代码
    !!!有需要的小伙伴可以通过文章末尾名片咨询我哦!!! ......