代码规范

来源:互联网 发布:网络简介的阅读答案 编辑:程序博客网 时间:2024/04/30 16:12

代码规范

前言

首先代码必须具有的是可读性,思想是:代码的写法可以使人在最短的时间内去理解,如果别人不理解你的代码,那么在未来别人接收你的项目的时候,别人会根本就看不懂,所以你的代码可能会被别人丢弃,因为他没有了可利用的价值,所以你也就没有了价值


把信息装到名字中

  1. 一个好的名字可以转载很多信息,一个好的名字可以代表你选择这个名字的目的和它所承载的值。

  2. 在给命令或者其他元素命名时,我们的目的是要把它们描述的更加具体和形象而不是更加的抽象,这个名字可以直接的描述这个方法要做什么事情。

  3. 变量名就像是一个小小的注释。不管你在里面填入什么信息,当每次有人看到变量名的时候都等同于看到了这些信息。

  4. 如果你的变量是一个度量的话,(如时间长度或者字节长度)这时我们最好在他们的名字后面加上它们的单位。

为了让大家让好的理解,那小编就给大家举一个栗子吧

栗子

这里写图片描述

大家看到这个图的时候有没有感觉这个主人公很冤啊,明明上面写的名字是动物,可是当打开的时候却惹来危险,原因就是因为名字没有起对,没有起到见名思意,所以才会导致这样的结果,其实这个栗子就相当于我们在代码中起名字一样,如果名称没有起好,不仅仅是给别人带来麻烦,更是给自己带来不便。

这个时候可能有人会问,如果见名思意岂不是要写很长一串文字,那岂不是很麻烦啊!

指导原则(短)

当我们遇到作用域小的里面我们可以使用短的名称,因为它的作用于小,里面的信息可以直接看到,所以我们采用短的名称便可。就算名称里面包含的信息不多,但是代码我们可以一眼就可以看到内容,所以采用短的名称。

栗子

当你去短期度假的时候你会比你长期度假带的东西少,因为你知道你呆的时间不长,所以你不会带太多的东西。

这个时候就有些调皮的人会问,那如果他要是长期度假呢?嘿嘿宝宝告诉你,就算它是长期度假,我照样解决它!

指导原则(长)

这个时候我们可以采用首字符缩进的方式,例如WangXueFen我就可以首字符缩进,写成WXFen的形式


审美

这里写图片描述

对于审美我想说的是大家应该都不陌生,审美越高的人,眼光也就越好,程序和人一样,一个人对审美的标准是脸蛋,一个人的外表,内在美,还有整体的气质,对于程序来说他的审美核心便是代码,代码是否整齐,并且已读。

三条原则

1.使用一致的布局,让读者很快的适应你的代码风格
2.让相似的代码看上去相似
3.吧相关的代码进行分组,形成代码块

方法

1.当我们的代码特别多,并且特别乱的时候我们可以采用方法来整理不规则的代码

2.减少代码的重复出现性
3,在需要的时候使列对齐
4.选择一个有意义的顺序,始终一直使用,(可以按照重要,不重要,按照字母顺序排序)
5.把申明块进行组织起来

千万不要使我们的程序看起来像一个猪圈哦

这里写图片描述


注释

当我们在敲机房收费系统代码的时候,我们的脑海里会有很多的想法和一些有价值的东西,但是我们出现问题的时候我们返还看我们的代码的时候,我们会特别的郁闷,天啊我这是写的啥?!这个时候的你毫无头绪,甚至怀疑这是不是自己写的!这个时候注释对于我们来说起到了一个极其大的作用啊

时候时候不需要注释

这里写图片描述

  1. 不要从代码本身就能快速推断的事实写代码
  2. 在我们写代码注释的时候不要为了注释而去注释
  3. 不要给不好的名字加注释,当有的人写注释的时候有一部分的注释是解释名字的含义,则这种注释就不需要了,直接把名字改掉就可,这里就体现了一个好的名字比注释更好用
0 0
原创粉丝点击