前端sdk相关技术汇总

1、API文档生成

使用jsdoc或typedoc(可以给typescript生成API文档)

通过下述的注释方式,来自动生成API文档

typedoc官方链接:

https://typedoc.org/

jsdoc官网(中文版)

https://www.jsdoc.com.cn/

jsdoc第3方文章

https://cloud.tencent.com/developer/article/2395148

2、示例网站搭建

每个功能有一个示例,类似,下面这个网站

http://mars3d.cn/example.html

(感觉这个是核心,也是和项目组沟通时,最常用的)

这些示例,可以快速让用户知道sdk有哪些功能,并且每个示例都相当于一个测试用例。

这里一般需要搭建一个可以边修改,边起作用的在线编辑器。

类似下面这种:

在左边编辑完代码后,点击"运行",即可让右边的示例,显示修改后的效果

3、代码格式化插件的统一

我之前用prettier,现在使用的是Biome

通过统一的格式化,在做"代码diff"的时候,更能清晰的看到改动的地方

避免看到大量的"不同格式化"代码而出现的很多diff

4、打包

之前使用了webpack和混淆插件,生成一个压缩后的、独立的js

现在使用的是vite,感觉vite性能更高,更流行。

5、前端命名规范

之前在命名上,有一些简答的规范,比如

a、类名首字母大写

b、常亮全部大写

c、方法使用小驼峰式命名

d、私有属性前面加"_"

还有时会检查eslint的一些警告并修复(通过eslint的规则来规范代码)

有时,也会参考其他规范,

比如"百度前端规范"

https://juejin.cn/post/6934946938789822472

命名规范

https://developer.aliyun.com/article/1500907

相关推荐
Bellafu66622 分钟前
selenium 常用xpath写法
前端·selenium·测试工具
blackorbird3 小时前
Edge 浏览器 IE 模式成攻击突破口:黑客借仿冒网站诱导攻击
前端·edge
谷歌开发者4 小时前
Web 开发指向标 | Chrome 开发者工具学习资源 (一)
前端·chrome·学习
名字越长技术越强4 小时前
Chrome和IE获取本机ip地址
前端
天***88964 小时前
Chrome 安装失败且提示“无可用的更新” 或 “与服务器的连接意外终止”,Chrome 离线版下载安装教程
前端·chrome
半梦半醒*4 小时前
zabbix安装
linux·运维·前端·网络·zabbix
清羽_ls5 小时前
React Hooks 核心规则&自定义 Hooks
前端·react.js·hooks
你的人类朋友5 小时前
“签名”这个概念是非对称加密独有的吗?
前端·后端·安全
西陵5 小时前
Nx带来极致的前端开发体验——任务缓存
前端·javascript·架构
10年前端老司机6 小时前
Promise 常见面试题(持续更新中)
前端·javascript