代码规范之空行思路和原则

Vertical Whitespace

c++规范,github:https://google.github.io/styleguide/cppguide.html#Vertical_Whitespace

This is more a principle than a rule: don't use blank lines when you don't have to. In particular, don't put more than one or two blank lines between functions, resist starting functions with a blank line, don't end functions with a blank line, and be sparing with your use of blank lines. A blank line within a block of code serves like a paragraph break in prose: visually separating two thoughts.

这与其说是规则,不如说是一个原则:如果不需要,就不要使用空行 。特别是,函数之间不要放置超过一两个空行,避免以空行开始函数,不要以空行结束函数,并且要谨慎使用空行。代码块中的空行就像散文中的段落分隔符:在视觉上将两个思想分开。

基本原则是:屏幕上显示的代码越多,就越容易理解程序的控制流程。有目的地使用空白来提供流程中的分隔。

一些有助于确定何时可能需要空行的经验法则:

  • 函数开头或结尾的空行无助于提高可读性。
  • if-else 块中的空行可能会提高可读性。
  • 在注释行前留空行通常有助于 提高可读性------新注释的引入暗示着新思想的开始,而空行则清楚地表明 该注释与后面的内容相关,而不是前面的内容。

最佳实践

在逻辑上相关的代码块之间保持适度的空白

不要过度使用,避免代码过于稀疏

保持一致的空白风格

相关推荐
打呵欠的猫4 天前
一个 Hook 让 AI 每次写文件前自动检查编码规范,违规代码再也提交不进来
前端·ai编程·代码规范
Asize4 天前
框架的说明书是写给 AI 看的:我用 Next.js 搭了个博客
人工智能·代码规范·next.js
梦梦代码精9 天前
深度体验BuildingAI:一款集成商业闭环的开源智能体平台
人工智能·docker·开源·代码规范
浮生望9 天前
ESLint Flat Config 工程化实战:从规则配置到团队代码规范落地
代码规范
电子科技圈10 天前
IAR与东软睿驰达成战略合作,强化软件开发效率与生态协作
设计模式·开源·软件工程·软件构建·代码规范·设计规范·代码复审
这个DBA有点耶12 天前
大事务的“事前预防”:监控、拦截、Kill,四层防线一次讲透
数据库·mysql·代码规范
沫璃染墨15 天前
《Qt从零入门系列(六):信号与槽进阶——从多种连接方式到Lambda表达式》
开发语言·c++·qt·代码规范·设计规范·qt5
嘟嘟071716 天前
SDD 规范驱动开发:从 vibe coding 崩盘到"两次创造"
设计模式·代码规范·vibecoding
JavaDog程序狗16 天前
【规范】这套 Git 规范,救了整个团队
git·代码规范·workflow