提升 Tampermonkey 脚本代码可读性的反思

更新日期: 2020-03-20 阅读次数: 9254 字数: 258 分类: Tampermonkey

晚上看了一段几年前写的会计网校自动挂学时的 Tampermonkey 脚本

我发现可读性太差了,要修改功能的时候,逻辑梳理起来异常痛苦。

为何痛苦

自动挂学时其实原理很简单,就是模拟正常的点击操作。

但是,我的代码存在几个问题

  • 代码头部一堆公共函数,而真正的逻辑在后面,看起来特别别扭
  • 代码全是各种遍历 tr, td 的操作,然后各种 1,2, 3 判断,不知所云

面向逻辑编程,而不是面向 HTML 编程

解决方法

  • 封装好功能,函数名可读性好。不要在循环里处理各种逻辑
  • 公共函数置后
  • 更多注释。难说一个脚本不会为何10年。。。
  • 全局 debug 开关,方便直观的看到问题出在哪里。或者封装一个 log 函数,在 debug 开关打开时打印。

tags: 代码规范

关于作者 🌱

我是来自山东烟台的一名开发者,有敢兴趣的话题,或者软件开发需求,欢迎加微信 zhongwei 聊聊, 查看更多联系方式