好的代码风格

缩进

缩进究竟是用 Tab 键好,还是用2、4、8个空格?
ヽ( ̄▽ ̄)و
4个。即使你喜欢使用 Tab 键,现在也有很多的 IDE可以通过设置来将 Tab 键扩展定义为几个空格。不使用 Tab 键的理由是,Tab 键在不同的情况下会显示为不同的长度,而 4 个空格的距离从可读性来说是最合适的。

命名风格

当我们的程序写的越来越复杂之后,给变量、函数或者类命名这样的简单的事情也不那么简单了,使用一致的命名风格是非常重要的。要做到格式一致,并且有意义,能根据变量名看出它的作用。所以,千万不要为了方便来使用缩写作为变量名,假设你使用res作为变量名,其他人如何才能知道你的意思究竟是resourceresponse还是reset?(,´•ω•)ノ"(´っω•`。)

  • 常量:全部大写
  • 类名:大驼峰——首字母大写,其后单词首字母大写
  • 方法函数名:小驼峰——首字母小写,其后单词首字母大写
  • 变量名:小驼峰或下划线——全部小写,单词之间用下划线连接
  • 系统保留:前置下划线(_),在命名中不要使用前置下划线

命名方法

  • 把成员变量都声明为private,这是一个很好的习惯。但是它在声明成员方法来操作私有变量时,却总是把方法命名得不伦不类。在一般的情况下,我们在操作类的私有变量时,会将给成员变量赋值的方法以set开头来命名,取私有变量的值的时候则是以get开头来命名。
  • 一个方法返回一个bool型的值,表示是或者不是。对于这一类的方法,在命名的时候应当以is开头,来代表这是一个返回true或者false的方法。

每行不要写太多

逻辑判断过多时,需要将每个逻辑单独放一行
例:
在这里插入图片描述
改:
在这里插入图片描述

注释

行注释和块注释并不是语义上的“一行的注释”或“一大段的注释”,而是指语法中的意思。
我们建议总是使用行注释,因为这样我们可以非常方便地去对一整块代码进行注释。(๑′ᴗ‵๑)

只有 3 种情况下可以使用块注释:

  1. 当我们需要把一大段代码注释掉的时候;
  2. 当自动化文档生成工具的语法要求使用块注释,或约定俗成使用块注释作为代码内文档的时候;
  3. 编程语言只有块注释语法的时候。

在其他情况下,我们建议永远都不要使用块注释。

总结ヾ(◍°∇°◍)ノ゙:

在这里插入图片描述

  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值