1、API文档生成
使用jsdoc或typedoc(可以给typescript生成API文档)
通过下述的注释方式,来自动生成API文档

typedoc官方链接:
jsdoc官网(中文版)
jsdoc第3方文章
https://cloud.tencent.com/developer/article/2395148
2、示例网站搭建
每个功能有一个示例,类似,下面这个网站
(感觉这个是核心,也是和项目组沟通时,最常用的)
这些示例,可以快速让用户知道sdk有哪些功能,并且每个示例都相当于一个测试用例。

这里一般需要搭建一个可以边修改,边起作用的在线编辑器。
类似下面这种:
在左边编辑完代码后,点击"运行",即可让右边的示例,显示修改后的效果

3、代码格式化插件的统一
我之前用prettier,现在使用的是Biome
通过统一的格式化,在做"代码diff"的时候,更能清晰的看到改动的地方
避免看到大量的"不同格式化"代码而出现的很多diff

4、打包
之前使用了webpack和混淆插件,生成一个压缩后的、独立的js
现在使用的是vite,感觉vite性能更高,更流行。
5、前端命名规范
之前在命名上,有一些简答的规范,比如
a、类名首字母大写
b、常亮全部大写
c、方法使用小驼峰式命名
d、私有属性前面加"_"
还有时会检查eslint的一些警告并修复(通过eslint的规则来规范代码)
有时,也会参考其他规范,
比如"百度前端规范"
https://juejin.cn/post/6934946938789822472
命名规范