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

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 块中的空行可能会提高可读性。
  • 在注释行前留空行通常有助于 提高可读性------新注释的引入暗示着新思想的开始,而空行则清楚地表明 该注释与后面的内容相关,而不是前面的内容。

最佳实践

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

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

保持一致的空白风格

相关推荐
奋进的电子工程师1 天前
汽车软件研发智能化:AI在CI/CD中的实践
人工智能·ci/cd·汽车·软件工程·软件构建·代码规范
大怪v2 天前
老乡,别走!Javascript隐藏功能你知道吗?
前端·javascript·代码规范
Craze_rd2 天前
Go 开发规范1
go·代码规范
小刚子要努力3 天前
基于Koa实现轻量化服务引擎
node.js·代码规范
前端很开门3 天前
程序员的逆天操作,看我如何批量下载iconfont的图标和批量下载 svg 图标
前端·chrome·代码规范
一碗清汤面3 天前
打造AI代码审查员:使用 Gemini + Git Hooks 自动化 Code Review
前端·git·代码规范
Dream耀3 天前
Promise静态方法解析:从并发控制到竞态处理
前端·javascript·代码规范
NRatel4 天前
Unity项目基本风格/规范
unity·c#·游戏引擎·代码规范·规范
围巾哥萧尘4 天前
五秒钟挑战网页开发实战🧣
代码规范
四七伵4 天前
接口设计的“潜规则”:为何字段 key 偏爱英文?
数据结构·代码规范·设计