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

相关推荐
我不吃饼干1 小时前
手写 Vue 模板编译(生成篇)
前端·vue.js
s小布丁1 小时前
vue2纯前端使用Docxtemplater生成word报告,包含echart图表,表格
前端
web小白成长日记10 小时前
企业级 Vue3 + Element Plus 主题定制架构:从“能用”到“好用”的进阶之路
前端·架构
APIshop10 小时前
Python 爬虫获取 item_get_web —— 淘宝商品 SKU、详情图、券后价全流程解析
前端·爬虫·python
风送雨10 小时前
FastMCP 2.0 服务端开发教学文档(下)
服务器·前端·网络·人工智能·python·ai
XTTX11010 小时前
Vue3+Cesium教程(36)--动态设置降雨效果
前端·javascript·vue.js
LYFlied11 小时前
WebGPU与浏览器边缘智能:开启去中心化AI新纪元
前端·人工智能·大模型·去中心化·区块链
Setsuna_F_Seiei11 小时前
2025 年度总结:人生重要阶段的一年
前端·程序员·年终总结
model200512 小时前
alibaba linux3 系统盘网站迁移数据盘
java·服务器·前端
han_13 小时前
从一道前端面试题,谈 JS 对象存储特点和运算符执行顺序
前端·javascript·面试