如何与其他开发人员共享代码?(和命名)

How To Share Code W/ Other Devs? (And naming)

本文关键字:代码 共享 其他 开发      更新时间:2023-10-16

tl;dr 我有我认为其他人会发现有用的代码,但不知道如何打包它以供其他人包含在他们的项目中并轻松修改。

我是C++新手,并创建了一个算法来有效地(足够)解决机器人的路径。该算法在一组点("节点")内创建可能的最长路径,两个限制是节点仅是单次访问,并且跳转到的下一个节点必须在当前节点的 X 距离内。

在"完成"机器人(学习练习)后,我决定从机器人中删除路径查找算法并将其打包为更通用和易于理解的代码片段以托管在 GitHub 上供其他人使用。

我很难找到有关如何最好地构建我的"库"的信息 - 可能是因为如果我更熟悉C++,这真的很明显。我不希望它像OpenCV一样是一个DLL,我唯一的另一个例子是.hpp JSON库+谷歌风格指南中的信息。

我不确定将我的代码作为标头(带有概述 + 使用文档)和 CPP(带有更具体的注释)文件分发是否会产生我想要的结果 - 即 JSON .hpp 工作流 - 我只需要下载文件,#include JSON.hpp,然后我能够调用它的方法。


<->

谷歌的风格指南适用于一个大型项目 - 而不是单个分布式文件 - 所以也许我应该将GitHub/"官方名称"命名为描述性的东西,但给命名空间/项目"SVNL"?

单次访问节点链接器

单个节点路径,用于单个节点之间距离内行进的最大节点数

访问最大化各个节点之间距离内的节点链接器

没有标准的方法来分发C++代码,但是分发像您这样的小型库的最简单方法是将其包装在一个简短的命名空间中并将其发布到 GitHub/GitLab/BitBucket/etc。

我会确保包括一个自述文件,解释项目是什么,如何使用它,以及如何构建它。编写构建脚本并将其包含在存储库中的奖励积分。