[文档] 厂商提供SDK需要满足的要求

第三方库SDK需要满足的要求

开发规范

1. 如果使用多线程，每个线程必须命名
2. 要有统一的log格式，方便在log文件内单独筛选出第三方库的log，ex: [LDLidar] .....
3. log打印要尽量少，关键信息必须打印，最好可以设置log的级别，如Debug，Warn...
4. 使用三位版本号x.x.x，每个版本的更新记录必须存到一个文件内
   1. 第三位：bug修复，极小的变更
   2. 第二位：一般的功能迭代
   3. 第一位：项目重构，功能变更较大
5. 每次修改的bug版本必须提供解决bug后的测试报告
6. 对外接口必须向前兼容
7. 对外接口必须有详细的介绍，包括调用顺序是否可变换等
8. 接口返回的错误码要有对应的详细解释，最好使用枚举，而不是简单的阿拉伯数字
9. 检查所有外界输入库接口的参数。如果参数有问题，则log附带具体的错误信息
10. 内部字符串使用统一的编码（推荐UTF8），只在接口和调用其他库时进行编码转换，避免内部字符串编码混乱

打包原则

1. 对外提供的包不能包含任何编译生成的文件和目录
2. 包中必须提供示例工程， 示例工程必须以最低的成本运行起来
3. 新版本发布必须附带压力测试的报告