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

相关推荐
程序员黑豆7 小时前
Java类型推断完全指南:从var到菱形运算符,掌握使用限制与最佳实践
java·前端·ai编程
To_OC7 小时前
踩了个 TS 的坑之后,我终于把 type 和 interface 掰明白了
前端·react.js·typescript
GreenTea8 小时前
深度解读 Anthropic 多智能体报告:更强的模型 ≠ 更好的协调
前端·后端·算法
浮生望8 小时前
前端API工程化:用 Mock 数据与 Axios 配置实现独立于后端的并行开发
前端
万少8 小时前
给 DeepSeek Harness 装个"应用商店":一条命令,595 个插件随你逛
前端·javascript·后端
波波0079 小时前
C# 15 重磅新特性: 带标签 break 与 continue:重新定义嵌套循环控制流
服务器·前端·c#
Brown.alexis9 小时前
es6知识点1-自备使用
前端·ecmascript·es6
小爬的老粉丝10 小时前
JavaScript 纯前端预览 WPS:先识别容器,再路由解析器
前端·javascript·wps
计算机魔术师11 小时前
新兴多智能体系统的模式与问题
前端
用户0595401744611 小时前
AI Agent 上下文污染踩坑实录:用 pytest + Redis 揪出 3 类记忆串号 bug,排查 6 小时
前端·css