资讯专栏INFORMATION COLUMN

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

MASAILA / 532人阅读

摘要:函数块不要太长,太长影响阅读,一个函数做一件事避免冗余代码和重复代码一个文件做一件事,整个文件代码不能太长,保持在行以内不要提交直接执行的信息,影响它人调试不要提交没用的注释代码,影响阅读和开发,如果要查看可以进行版本历史我的代码规范原则影

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

避免冗余代码和重复代码

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

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

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

我的代码规范原则

影响阅读的代码,那就是不好代码

很多很相似的代码,那一定是重复冗余了

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

代码规范和不规范举例 函数块不要太长,太长影响阅读,一个函数做一件事

太长的函数块:建议函数块以编辑器的一屏为准,几乎不用滚动条可以看完整个函数

可以看到这里的函数每行30行至更多。打开后必须滚动条才能看清楚这个函数

改良后的函数块

一个函数平均10-20行之间

避免冗余代码和重复代码

冗余代码示例

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

改良后冗余代码示例

发现重复和冗余的规律,统一用函数封装起来

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

文件代码结构划分

一个method可以拆分成文件夹,通过index入口导入

一个文件做一件事,可以看到一个文件才不到200行

还有文件顺序问题,比如vue钩子函数,建议不用把created写在最后

文件夹结构

公共的css提出来

公共的方法用mixin提出来

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

及时运行的log信息

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

杂乱的log控制台

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

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

版本历史

一起努力吧

--
作者:刘伟波

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

来源:刘伟波博客

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

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/103973.html

相关文章

  • PHP代码修正之CodeSniffer

    摘要:它包含两类脚本,和地址脚本对文件定义了一系列的代码规范通常使用官方的代码规范标准,比如的,能够检测出不符合代码规范的代码并发出警告或报错可设置报错等级。脚本能自动修正代码格式上不符合规范的部分。 Last-Modified: 2019年5月10日13:59:27 参考链接 PHP开发规范之使用phpcbf脚本自动修正代码格式 在PhpStorm中使用PSR2编码规范phpcbf脚本自...

    khs1994 评论0 收藏0
  • 前端JS代码规范

    摘要:缩进为个空格句末必须用分号结尾待定就无分号注释单行注释多行注释代码注释和再提交重要函数或者类等都要添加头描述字符串拼接应使用数组保存字符串片段,使用时调用方法。 前言 下面这几点将工作中所踩的一些坑简单整理了一下,团队几个人开发,一些默契就比较重要,可以提高开发效率和代码的可读性 命名,编码和注释 命名 A.文件夹命名:文件夹、文件的命名与命名空间应能代表代码功能,可读性强,如hubB...

    zhiwei 评论0 收藏0
  • 【译】ECMAScript文档---序言及1-6章(上)

    摘要:随后,它出现在公司之后的浏览器,以及从微软从起发布的所有浏览器上。标准的第版在年月的大会上被表决接受。第版在年月底大会上被采纳。 前言   本系列译文的初衷旨在希望更多人能够了解关于JS的一些基本概念,遇到原理性的问题时多去翻翻文档,而不是在社区无休止的重复提出某些在文档中能够非常方便快捷就能找到的东西。   精力和水平有限,所以暂时只打算尝试翻译前面几章概括性的介绍,同时后面的章节大...

    wind3110991 评论0 收藏0
  • React.js 最佳实践(2016)_链接修正

    摘要:译者按最近依旧如火如荼相信大家都跃跃欲试我们团队也开始在领域有所尝试年应该是逐渐走向成熟的一年让我们一起来看看国外的开发者们都总结了哪些最佳实践年在全世界都有很多关于新的更新和开发者大会的讨论关于去年的重要事件请参考那么年最有趣的问题来了我 译者按:最近React(web/native)依旧如火如荼,相信大家都跃跃欲试,我们团队也开始在React领域有所尝试. 2016年应该是Reac...

    syoya 评论0 收藏0

发表评论

0条评论

MASAILA

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<