代码请加注释——美观代码之我见

  越来发现自己无法忍受乱七八糟的代码。没有函数注释,没有变量说明,一个函数跟着一个函数书写,连换行都没有。虽说使用IDE可能对小工程有大材小用之嫌,但好歹能让自己代码更加美观,书写更加流畅。写的代码让人没有看的欲望,真不如重新书写规范代码。

  一个合格的代码人首先要将代码写的美观,在琢磨美观的过程中,就会考虑重构,重构过程中就会思考模式,一步步将自己的全局观树立起来。

  我一般用的美观:

  1每个函数都加上总体说明,说明这个函数的功能,参数功能,函数作者,创建日期,修改日期。

  2函数里面的变量尽量加上注释,说明每个变量的意图,将代码分块,不同功能的代码尽量换行和加注释标明。

  “一个函数不要超过5行”,“所谓设计,就是将代码组织得更加易懂。易懂的东西才容易复用,容易复用才叫好的设计”,从别处搞来的话,觉得很对!

  看了这话,觉得自己以前写代码,还是有时过于复杂,其实是可以将一个函数拆分成好几个的。我以后就尝试将函数尽量分的更加细化,短小精悍,更好的分清各个代码块的责任,分成各个独立的函数,对于理解程序意图,修改其中的代码也是很方便的。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值