V2EX 19小时前
[程序员] 跨平台 SDK 类名是否需要添加企业名称缩写前缀?
index_new5.html
../../../zaker_core/zaker_tpl_static/wap/tpl_guoji1.html

 

文章讨论了在跨平台SDK中,是否应添加企业前缀(如FB)以及对外文件名是否添加前缀的问题,分析了不同观点和实际案例。

我们提供客户端 sdk 服务,是跨平台的 sdk ,支持 android ios ,Windows mac linux 系统,其他中 android 使用了 java 对接口进行封装 ios ,mac 使用了 oc 对接口进行封装,linux 和 Windows 是 c++接口。

我的问题是,我们定义的类和结构体类型,要不要添加企业的前缀,我们企业的前缀是 FB 缩写,比如 EngineConfig 写为 FBEngineConfig, Class LearnEngine,写为 FBLearnEngine

个人觉得为了简洁,C++完全可以通过命名空间 fb::LearnEngine 避免冲突,添加前缀的好处也就是可以一眼看出这是 FB 公司提供的库,除了这个感觉没有其他好处了吧

开源库,比如 opencv ,mnn 都没有添加 CV ,MNN 之类的前缀,但是看一些云厂商,比如腾讯,火山,他们又都添加了 TX 之类的前缀,所以我有些疑惑了。目前我倾向不添加前缀,不知道会不会有什么坑

另外对外的文件名要不要添加 fb_的前缀呢?

Fish AI Reader

Fish AI Reader

AI辅助创作,多种专业模板,深度分析,高质量内容生成。从观点提取到深度思考,FishAI为您提供全方位的创作支持。新版本引入自定义参数,让您的创作更加个性化和精准。

FishAI

FishAI

鱼阅,AI 时代的下一个智能信息助手,助你摆脱信息焦虑

联系邮箱 441953276@qq.com

相关标签

SDK命名 企业前缀 命名规范
相关文章