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

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

最佳实践

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

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

保持一致的空白风格

相关推荐
PPPHUANG2 天前
一次 CompletableFuture 误用,如何耗尽 IO 线程池并拖垮整个系统
java·后端·代码规范
zhouzhouya3 天前
码上星辰,人间烟火:我的2025
前端·程序员·代码规范
程序员Agions3 天前
程序员邪修手册:那些不能写进文档的骚操作
前端·后端·代码规范
晨米酱3 天前
轻量级 Git Hooks 管理工具 Husky
前端·代码规范
parade岁月4 天前
把 Git 提交变成“可执行规范”:Commit 规范体系与 Husky/Commitlint/Commitizen/Lint-staged 全链路介绍
前端·代码规范
哈基闻4 天前
想要更多,那就“多继承”
代码规范
zhz52144 天前
后端代码规范文档示例
重构·bug·代码规范·结对编程
卖火箭的小男孩7 天前
Flutter 开发代码规范(优化完善版)
flutter·代码规范
Piper蛋窝7 天前
AI 有你想不到,也它有做不到 | 2025 年深度使用 Cursor/Trae/CodeX 所得十条经验
前端·后端·代码规范
莫比乌斯环7 天前
【安全专项】如何成为一名“火眼金睛”的安卓侦探?
前端·代码规范