前端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

相关推荐
en.en..1 分钟前
Linux mmap 内存映射深度解析:基于帧缓冲 /dev/fb0
java·服务器·前端
后台模板学习40 分钟前
从0到1用Vite构建电商订单系统前端性能优化方案
前端
Wang's Blog40 分钟前
Vibe Coding一人即团队系列58: HTML演示文稿自动生成
前端·人工智能·html
FoldWinCard1 小时前
基于k8s高可用web集群
前端·容器·kubernetes
神探小白牙1 小时前
海康视频在vue2.0中的使用
前端·音视频
Tanjia_kiki1 小时前
谷歌浏览器中F12编辑并重发请求
开发语言·前端·javascript
honkun61 小时前
vue 表格组件 vxe-table 实现拖拽列字段自动生成透视表汇总
前端·javascript·vue.js
新中地GIS开发老师2 小时前
WebGIS开发入门 | 从 Web 开发到地图开发,差别在哪儿?
前端·vue·webgis
IMPYLH2 小时前
HTML 的 <p> 元素
前端·javascript·html
leoZ2312 小时前
第 4 篇:布局骨架——页面壳、栅格、卡片
前端·javascript·vue.js·opencv·计算机视觉·数据挖掘·语音识别