loading...

8

自我总结代码规范,欢迎修正

javascript读完大概需要7分钟

  • 发布时间:2019-04-29 09:05 星期一
  • 刘伟波
  • 520
  • 更新于2019-04-30 16:55 星期二

http://images.liuweibo.cn/image/common/4e98d4964bba4bf8a142d78ae0f561ed_1556502144975_91876_1556502218526.jpg

  1. 函数块不要太长,太长影响阅读,一个函数做一件事
  2. 避免冗余代码和重复代码
  3. 一个文件做一件事, 整个文件代码不能太长,保持在300~500行以内
  4. 不要提交直接执行的console.log信息,影响它人调试
  5. 不要提交没用的注释代码,影响阅读和开发,如果要查看可以进行版本历史

我的代码规范原则

  • 影响阅读的代码,那就是不好代码
  • 很多很相似的代码,那一定是重复冗余了

以下是最近在某代码仓库js中发现不规范的代码,当然还有css规范了,有兴趣的可以自己上网搜索

代码规范和不规范举例

函数块不要太长,太长影响阅读,一个函数做一件事

  • 太长的函数块:建议函数块以编辑器的一屏为准,几乎不用滚动条可以看完整个函数
  • 可以看到这里的函数每行30行至更多。打开后必须滚动条才能看清楚这个函数

http://images.liuweibo.cn/image/common/太长的函数块_1556500541041_80408_1556500607102.png

  • 改良后的函数块
  • 一个函数平均10-20行之间

http://images.liuweibo.cn/image/common/改良后的函数块_1556500599756_60882_1556500629150.png

避免冗余代码和重复代码

  • 冗余代码示例
  • 如果你发现了很多地方代码很相似,那肯定是代码重复冗余了

http://images.liuweibo.cn/image/common/冗余代码示例_1556500214979_105654_1556500322420.png

  • 改良后冗余代码示例
  • 发现重复和冗余的规律,统一用函数封装起来

http://images.liuweibo.cn/image/common/改良后冗余代码示例_1556500312094_61448_1556500342435.png

一个文件做一件事, 整个文件代码不能太长,保持在300~500行以内

  • 文件代码结构划分
  • 一个method可以拆分成文件夹,通过index入口导入
  • 一个文件做一件事,可以看到一个文件才不到200行
  • 还有文件顺序问题,比如vue钩子函数,建议不用把created写在最后

http://images.liuweibo.cn/image/common/文件代码结构划分_1556500884307_81721_1556500891031.png

  • 文件夹结构
  • 公共的css提出来
  • 公共的方法用mixin提出来

http://images.liuweibo.cn/image/common/文件夹结构_1556501878761_9193_1556502019717.png

不要提交直接执行的console.log信息,影响它人调试

  • 及时运行的log信息
  • 写代码的时候可以用,提交尽量不要提交console.*信息

http://images.liuweibo.cn/image/common/及时运行的log信息_1556501040318_34890_1556501054303.png

  • 杂乱的log控制台

http://images.liuweibo.cn/image/common/杂乱的log控制台_1556501187781_68635_1556501198020.png

不要提交没用的注释代码,影响阅读和开发,如果要查看可以进行版本历史

  • 不要提交注释代码可在版本历史查看

http://images.liuweibo.cn/image/common/不要提交注释代码可在版本历史查看_1556501356291_47046_1556501396795.png

  • 版本历史

http://images.liuweibo.cn/image/common/版本历史_1556501389366_62492_1556501504690.png
http://images.liuweibo.cn/image/common/vue代码规范xmind图_1556614478517_220565_1556614506131.png

一起努力吧

http://images.liuweibo.cn/image/common/eef8cd777db65a7dd58d59c73c818ea4_1556502183522_30795_1556502235662.jpg

--
作者:刘伟波

链接:http://www.liuweibo.cn/p/252

来源:刘伟波博客

本文原创版权属于刘伟波 ,转载请注明出处,谢谢合作

你可能感兴趣的文章

    发表评论

    评论支持markdown,评论内容不能超过500字符
    关于技术问题或者有啥不懂的都可以来 我的视频空间 提问, 推荐作者总结知识点 前端知识体系, 感謝支持!