代码整洁之道-1 如何命名

在学校的时候,老师们都说要学会为代码加注释,这是一个良好的习惯,注释越多越好。
但是实际并不是这样,对于代码来说,并不是注释越多越好。
当你的代码不得不需要特别多的注释才能让别人看懂,只能说明你的代码不够整洁,不得不用长篇大论来解释自己的代码。

下面所有的规则都是建议,并不是强制性的要求,要根据实际情况去选择更加合适的写法。

命名很重要,要多花时间去想。

如果想道了更合适的,就多花些时间把原来的替换掉。(不要影响他人使用)

  1. 需要添加注释来说明的命名就是不够完美的命名
    尽量让自己的命名不加注释也能让别人看懂。
  2. 不要让名称太过相似:
    如果你的项目中同时存在product,productInfo,productData这三个类,一定会让人看着就感觉头大。
  3. 类名推荐使用名词和名词短语,方法推荐使用动词或动词短语。
  4. 为每一个抽象概念选一个词,并一以贯之。
  5. 灵活使用语境:
    相同的变量名称放入不同的语境中会表示不同的意思。可以利用这一点减短自己的变量名称,让语境来帮你将变量解释完全。
  6. 不要害怕名称过长,相对于名称过长所造成的麻烦。没有解释清楚意思更加麻烦。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值