写点什么

通用编程风格

用户头像
顿晓
关注
发布于: 2020 年 06 月 30 日
通用编程风格

面向对象风格最小交集,可通用于所有支持面向对象的语言。

  • 目录名和文件名:小写+蛇形

  • namespace/package:小写+蛇形

  • namespace/package 层级和目录名/文件名层级保持一致

  • 类名:大驼峰

  • 公有函数名:大驼峰

  • 私有函数名:小驼峰

  • 类属性:小驼峰

  • 临时变量:小驼峰 

为了简化记忆,可以总结为:源码中使用大小驼峰,非源码时使用小写蛇形。

好处

业务代码采用该风格编写,可以让公司几乎所有代码风格都保持一致。

详解

  • 类名和文件名没有强绑定要求

  • 鼓励小类,一组小类可以在同一个文件内

  • 如果类只是一组公有函数的集合,可以不用类,将函数直接做为命名空间/包下的公有函数

  • 组织层级,命名空间/包和文件比类灵活,更合适

  • 目录和文件名为了兼容不支持大小写区分的文件系统,所以统一用小写,用蛇形是为了和驼峰做区分,表达其只是组织,不涉及内容

  • namespace/package 为了和目录/文件保持一致,也用小写+蛇形

  • 类名和公有函数如何区分:函数后面有括号

  • 类名和公有函数属专有名词,用大驼峰更能表达其声明的意图

  • 剩余的是实现的描述,用小驼峰表达其是实现细节

发布于: 2020 年 06 月 30 日阅读数: 48
用户头像

顿晓

关注

因观黑白愕然悟,顿晓三百六十路。 2017.10.17 加入

视频号「编程日课」 一个不爱编程的程序员, 一个用软件来解决问题的工程师, 一个有匠心的手艺人。

评论

发布
暂无评论
通用编程风格