首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

SDK 开发规范

最近公司在做SDK,这里总结下SDK开发规范 开发规范 API功能单一,减少类似enum的入参设计 线程处理, 如非必要不要使用应用主线程,不能长时间占用,SDK内应有一个专门线程处理SDK 相关操作...or eft-sdk-xxx-ios demo 项目命名:demo,包名:cn.eft.sdk.xxx.demo sdk 项目命名:mEftXxxSDK,包名:cn.etf.sdk.xxx 注释规范...开发中,需要尽量避免依赖第三方库以免引起不必要的冲突 如果确实因为项目需要,要引入一些开源库,可以通过源码集成的形式引入,再更改一下包名(类名),避免集成冲突。...对外提供的包不能包含任何编译生成的文件和目录,如安卓的build目录 iOS XcodeData 使用脚本一键打包,提升打包效率,降低手动打包带来的出错率 打包脚本需与项目其他脚本分离,尽量职责单一, 包中尽量提供示例工程, 示例工程必须让开发者以最低的成本运行起来...SDK需要有较强的容错性,增减稳定,增大力度对于SDK内部异常进行捕获。 SDK内部对于关键路径要有详细的Log记录,便于后期排查问题。 各个库之间要做到高内聚,低耦合 核心代码的安全性

2.9K31
您找到你想要的搜索结果了吗?
是的
没有找到

LoRaNode开发——初识SDK

.vscode:里面是用VScode打开文件的时候的一些配置; cmake:cmake主要是用于构建Makefile文件用的; Doc:主要是原理图和开发环境的说明 src:源码,也是我们最需要关注的文件...gitignore:与git工具相关的文件 CMakeLists.txt:cmake工具的依赖文件 LICENSE.txt:许可证之类的说明 readme.md:对这个文件夹的一些详细说明 在windows下开发我们主要关注两个文件夹...development-environment.md主要是说明了开发环境的构建:默认是linux下的vscode,编译工具是GCC,Makefile文件构建工具是Cmake。...classC节点 commom:共用的一些文件 fuota-test-01:基于LoRaWAN的固件无线升级 periodic-uplink-lpp:lpp协议的实现 以上就是LoRa Node 最新的SDK

1.3K20

关于相机SDK开发

SDK 采集图像的问题 6.工业相机SDK之opencv二次开发 1.工业相机编程模型和流程 不同的工业相机提供不同的编程接口(SDK),尽管不同接口不同相机间编程接口各不相同,他们实际的API结构和编程模型很相似...对于上位机软件开发人员来说拿到一个硬件上位机编程任务。 首先应该阅读了解其SDK概念,再按照其介绍的SDK开发流程阅读其提供的实例,修改相应的实例为自己所用,有不懂的函数查询一下其用法即可。...转自:CSDN论坛 6.工业相机SDK之opencv二次开发 做视觉的第一步是选好相机镜头等硬件设备,接下来就是将自己开发的算法在硬件上实现。...我最近做一个项目,实现了一下Opencv在相机SDK上的运用,下面小结一下具体实现步骤. 1. 安装相机自带的驱动和SDK开发包; 2....用VS2010新建一个工程,配置好SDK的动态链接库(或者静态),具体动态链接库的使用可参见孙鑫的那本书,这里不多说; 3. 条用SDK开发包中的函数建立相机和PC机件的链接; 4.

2.1K53

SDK开发经验之开发习惯

关于开发习惯这部分内容,其实跟SDK关系不大,只是在SDK开发中逐渐沉淀下来的,而且有些也已经纳入到我们的流程中了,所以就简单汇总说明一下。...例如DB版本、SDK版本等内容。将这些要检查的位置加上TODO,每次提测前只需要把TODO过一遍就过了所有的要检查项目。...开发中有时候为了配合测试一些新功能会对一些参数作调整,例如 定时任务的间隔时间 一些配置开关,例如加密不加密等 一些特定逻辑,可能会写死为false或者true强制走进分支方便测试等 有时候开发周期比较长...对于SDK的功能,开发者怎么去接入,其实我们也用TODO标签标注,开发者接入某一个功能,只需要处理了对应的TODO即可完成接入,不过貌似没有人关注。...提醒类的: //TODO GAME 游戏需要在onCreate里面完成初始化 切记尤其是个人临时添加的TODO,一定要加上负责人,不然最终会跪了~~~ 无用代码的处理 任何SDK

791100

SDK开发经验之文档

我们遇到的问题 我们的SDK做了这么久,被开发商嗤之以鼻最多的问题之一就是文档。主要表现在: 问题的原因比较多,主要是三个方面: 没有完整的线上文档,所有的接口文档都是跟随版本包。...因为这样开发商下载到一次以后就再也不会更新了…… 文档online化总要解决,不然上面的问题会一直存在。为了让伟大的开发哥哥们不受困于wiki,最后在github终于找到了神器。...使用Markdown可以大大提高开发者的开发效率。 分模块:如果你的SDK够大,建议最好是按照模块来写文档。...SDK介绍相关: SDK介绍:介绍SDK的能力、包括的模块、名词解释、SDK下载地址、版本历史等内容 接入指引:主要介绍开发者从下载完SDK到将SDK合入自己工程的工作。...包括SDK包内容介绍、SDK的架构的简单介绍、开发者接入SDK、更新SDK的操作指引、打包的混淆规则等内容。 API文档:按照模块区分介绍对应模块API的使用方法。

1.6K80

SDK开发经验之版本

对于应用开发者,更新版本可能是件很开心的事,因为说明在不断的优化和改进。然而对于SDK开发者来说,对于版本更新的感觉却是复杂的,开心又心塞。...稳定版本和开发版本的存在是为了提高SDK的版本质量,同时结合版本发布的一些策略,降低SDK版本质量对使用者的影响以及SDK的bug的影响范围。 这里对开发版再增加一点说明。...推荐做法: SDK开发完成到最后对外提供,建议包括以下过程:开发自测、专项测试、发布开发版(或者叫内测、小范围灰度)、转为稳定版、下线版本这样几个周期。 测试我会在下面继续说。...当你是一个SDK的客户端开发的时候,一切就都变了。 对于SDK的客户端开发,虽然你可以任性的在不同版本随意的优化和调整而不会招致什么问题。...SDK存在很重要的一个价值就是方便开发的接入。当SDK接入、更新的成本超过甚至逼近开发直接对接的成本时,这个SDK其实是失败的,而且也失去了应有的意义。

1.7K90

SDK开发经验之Demo

所以他们就会说你们的SDK不好接入,你们要优化,要有调用事例,胳膊拧不过大腿,最终就都有了。...文档并不能非常整体的、清晰的展现你的SDK的整个系统和调用方式。 对于刚接触你SDK的人,你用一个demo来介绍SDK的功能会比文档形象更多,也更易理解。...展现形式 最好是独立的包含完整功能的APK应用:如果只是部分模块或者部分接口的事例代码,那么文档足矣,根本无需Demo 虽然Demo的主要功能是为了协助用户了解SDK的功能,但是也别太丑了:之前我们的...Demo中功能演示最好也分模块来展示,而不是把所有的功能揉在一起:我们的SDK有几十个接口,Demo最开始所有的功能用一个自动生成的ListView放在一起,加上配色的问题,每次测试某个功能都要找呀找,...不然开发看懂你的demo的时间他都接完了。 暂时就写这么多,之前感觉挺难写的,发现逗比起来就好写多了,暂时这么多,后续想起来慢慢补充。

94160

SDK开发经验之测试

这个在关于版本号的SDK设计心得之版本号(点击查看)会重点说明。 检查第三方sdk的版本是否正确 由于我们的SDK还接入不少SDK,因此需要确认第三方的版本是否正确。...确认所有TODO标签已经完成, 没有遗漏, 确定要遗留的问题必须注释写明原因 关于TODO我会在SDK那些事之SDK开发中的一些开发经验(点击查看)专门说,一定要看,是干货。...可以明确开发和测试不应该是敌对关系,两者的共同目标都是为了出一个高质量的版本。因此开发不要觉得测试追债一样,这个最重要。...另外对于某些新功能模块,开发可以提供一些开发的设计思路给测试,协助测试完成测试用例的设计。如果有遗漏,也不要沾沾自喜,还是要据实以告,否则万一漏了某个分支就是大问题。...黑盒 黑盒主要是指demo,我们会为游戏提供一套我们的接口调用的demo(我会在SDK开发经验之Demo和文档(点击查看)中描述demo的价值)。

1.4K60

Sentry 开发者贡献指南 - SDK 开发(性能监控:Sentry SDK API 演进)

Sentry 监控 - Search 搜索查询实战 Sentry 监控 - Alerts 告警 Sentry 监控 - Distributed Tracing 分布式跟踪 Sentry 监控 - 面向全栈开发人员的分布式跟踪...Sentry 监控 - 私有 Docker Compose 部署与故障排除详解 Sentry 开发者贡献指南 - 前端(ReactJS生态) Sentry 开发者贡献指南 - 后端服务(Python/...Go/Rust/NodeJS) Sentry 开发者贡献指南 - 前端 React Hooks 与虫洞状态管理模式 Sentry 开发者贡献指南 - SDK 开发(性能监控) Sentry 开发者贡献指南...- SDK 开发(事件负载) 介绍 早在 2019 年初,Sentry 就开始尝试向 SDK 添加跟踪功能。...Python 和 JavaScript SDK 是设计和开发第一个概念的测试平台。概念验证于 2019 年 4 月 29 日 发布, 并于 2019 年 5 月 7 日交付给 Sentry。

1.2K40

SDK开发经验之自动构建

本文的侧重点还是集中在SDK的自动化构建中主要做那些工作。 Android自动构建工具 早期的Android项目使用ADT(Eclipse)来开发,当时的自动构建工具大多是用ant。...下面就介绍下我们的自动构建都做了什么工作: 分配版本号 我们SDK早期的版本号由人工维护,因此在SDK开发经验之测试(点击查看)介绍过,我们会在版本发布的checklist里面增加版本号的确认,确保发出去版本的版本号是正确的...SDK编译 代码编译,这一步仅仅为了获取SDK相关的发布内容。...生成版本信息文件 为了能第一时间确认SDK的版本相关的细节信息,我们会在SDK里面增加一个版本信息文件,里面保存SDK的构建时间、版本、对应SVN的版本以及对应svn tag的标签。...生成demo工程 开发中的demo是依赖SDK的源码的,但是对外提供的demo不能用这样的方式。

92990

短视频 SDK 开发 (一) 开发一款短视频 SDK 需要具备哪些知识?

那么,作为一个音视频零基础的人来说, 开发一款短视频 SDK 到底需要具备哪些知识呢? 下面就由我为大家介绍一翻(ps:以下学习路径仅代表个人观点)。...❝接下来的日子我准备从 0-1 写一个如何开发一款音视频编辑的 SDK 系列文章,下面是我的计划。 短视频 SDK 开发 (一) 开发一款短视频 SDK 需要具备哪些知识?...短视频 SDK 开发 (二) 短视频 SDK 架构设计 短视频 SDK 开发 (三) FFmpeg + OpenGL ES + OpenSL ES + soundtouch 实现音视频播放器 短视频 SDK...开发 (四) Camera + MediaCodec + OpenGL ES + OpenSL ES + FFmpeg MP4Muxer 实现音视频实时录制封装为 MP4 短视频 SDK 开发 (五)...滤镜、贴纸、水印实现 短视频 SDK 开发 (六) 美颜特效实现 短视频 SDK 开发 (七) 音视频剪辑实现 ❞ 基础知识 1、你必须要有 「C/C++」 开发语言基础,可以看我之前写的文章 音视频学习

1.7K30

手游sdk搭建开发都需要哪些功能?如何挑选游戏sdk

所以游戏SDK就把这些共同性的问题给抽出来,通过一定的接入规范,形成一个独立的软件包,只需要按照接入规范,引进游戏包资源,对接接口即 手游联运平台sdk主要包含三种体系,账号体系,支付体系,数据体系。...当然,游戏sdk还提供运营层面的功能,比如SDK的悬浮窗、公告推送、个人充值记录查询等等,属于锦上添花的东西。 了解了手游联运平台sdk的功能,我们如何挑选合适的手游sdk系统呢?...这里可以了解一下溪谷sdk,有金牌售后一对一服务,可以快速解决客户问题。...3、sdk不能占用太大地方 对于一款SDK来说,体量小非常重要。因为本来就是帮工,不能将所有的空间都占为己有,喧宾夺主。所以选择sdk时还要主要一下它的体量大小。...以上就是给大家介绍的手游联运平台sdk有哪些功能?如何挑选sdk的小知识了。

84920

M5310-E之SDK开发

1、SDK编译 build执行编译,build clean清除编译 win+R进入windows的命令行 cd到SDK的根目录 build 编译成功则会在out目录下生成 .fwpkg 编译产物...,可直接下载到板子里面 2、SDK根目录结构介绍 OpenCPU SDK代码目录结构,如下图所示: 名称 描述 custom 用户代码目录、用户程序入口 docs 文档 examples 示例代码...include OpenCPU API 头文件 out 编译输出目录 prebuild 预编译文件 third-party 第三方开源代码库 tools 编译工具脚本 在进行二次开发时可以多参考官网提供的手册以及...docs目录和examples目录,提供了相当丰富的外设驱动源码例程 3、SDK重要文件介绍 我们比较关心的是如何添加.c和.h文件到工程中,以及如何通过编译 3.1 程序入口函数 以下cm_opencpu_entry

12830
领券