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

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

最佳实践

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

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

保持一致的空白风格

相关推荐
异常君14 小时前
Java 中 try-catch 的性能真相:全面分析与最佳实践
java·面试·代码规范
写bug写bug2 天前
如何正确地对接口进行防御式编程
java·后端·代码规范
翠莲2 天前
vue3+TS+eslint9配置
前端·代码规范
FogLetter5 天前
从语义化标签到JS变量:前端工程师的必修课
前端·javascript·代码规范
red润5 天前
JavaScript 二维数组初始化:为什么 fill([]) 是个大坑?
前端·javascript·代码规范
异常君6 天前
Java 逃逸分析:让你的代码性能飙升的秘密
java·面试·代码规范
狂炫一碗大米饭6 天前
关于 TS 中的装饰器
typescript·代码规范
异常君6 天前
深入理解 Java 类卸载:避免 90% 的内存泄漏问题
java·代码规范
异常君7 天前
Java 应用如何防御 SYN Flood 攻击?
java·数据库·代码规范
Gladiator5757 天前
记录-day002-git
代码规范