会说话的代码

在开发中,说实话,一般的公司可能都不会有写文档的时间,并且个人也不一定都有这习惯。

但是对于你来说,代码就是你的一张脸,当别人读的时候,你总不希望别人说:“天阿!怎么这么丑!!!”如果正好你这时在旁边,那将会是一件多么悲催的事~~

那么让我们简单的为这张脸美容一下,代表自己嘛,肯定不要太悲催了,哈哈。

让代码自己说明白为什么这样,大家肯定想到了写注释。

写注释也有好多种写法,比如说能直接生成javaDoc的注释风格等

但是即使生成了,这文档又会有多少人去看呢?又有多少人能看懂呢?

所以,还是让我们来简单点吧,只会占用你一点点时间,就让你的代码看起来更加的漂亮。

CSS

对于CSS,也许经常会使用到缩写,但是过一段时间,自己也许都已经已经不记得了~囧!

image

写一些必要的注释,解释缩写的意义。对于其他人来看,这让他们更快的明白;对于自己过一段时间后再看,可以迅速的回想起当时的思路,易于修改。

image

jQuery ui theme的风格,这种命名方法,个人感觉是非常不错的方法,即易于记忆,同时也易于理解。

image

命名空间,虽然CSS里面这个概念很弱,或者说因为权重的问题不存在命名空间这个概念。但是如果把页面上每一块都分割开的话,那么每一块应该是相对独立,在独立的范畴内应该使用同一父级的class做为命名空间。这不仅仅是权重的问题,也增强代码的可读性。

多使用换行,对于不同的区块,应该使用换行让代码上的逻辑也更清晰。

javascript

javascript有很多不同的注释写法,我这里绝对不是标准的,大家请仅仅做为参考。

写注释的目的就是为了让代码自己可以解释自己,并且说明自己的用法等。

image

在注释段里面放些简单的实例,让新人更容易理解已经公司现有的Base类库。

image

遵循着某总风格。因为javascript的灵活性,使得使用这门语言的人可以用各种写法来达到目的,但是实事让,如果在团队里每个人的代码风格都相差很大,不但看起来不爽,读起来更不爽。

所以我们一定要遵循某种结构。

噢,对了,在组件的前面,或者段落前要写上自己的名字,这点很重要,因为其他人要修改的话,至少要知道这东西是谁做的,可以找谁商议。

 

以上一些步骤其实都不复杂,但是你的代码会因此清晰点。

输入的指令是要让编译器明白,如果它不明白,OK没商量直接给你抛Error~

写注释,是为了给人看的,如果只是机器能看懂,那还不如不写了。

此条目发表在 杂谈, 闲聊 分类目录,贴了 , , , 标签。将固定链接加入收藏夹。