糟糕的代码样本会让您远离图书馆吗？

Question

我一直在评估纸上看起来很棒的框架。问题是示例代码不完整且质量差。提供的参考实现在很大程度上并不意味着使用（因此它们也可以被视为示例代码）并且只是成功地使我感到困惑。

我知道在纸上看起来更好看，但我对示例代码的体验让我远离进一步的调查。

您是否让糟糕的代码示例改变您对框架/库的判断？到目前为止，我的经历类似于“恢复效果”：如果有人不努力拼写检查他们的简历，他们可能无法得到这份工作......

Answer 1

对我来说，确实如此。我倾向于避免代码样本不完整的库。如果库是开源的，我会忽略它，因为我可以直接查看代码并查看库的内部是否合理，我知道，如果有一天出现问题，我可以（如果必须）修复它

如果图书馆是商业图书馆，他们的样本和/或文件很差，我会去别处看看。我只是将其视为风险管理 - 糟糕的样本让我担心图书馆的质量。

无论纸上或理论上有多好，在编程时它仍然可以是垃圾。

Answer 2

我认为这是拒绝和评估其他图书馆的正当理由。作为库的潜在用户，缺乏文档和/或错误的代码示例给人的印象是该库还不够成熟，不足以供第三方使用。及时它可能会获得缺失的部分，但在那之前，我认为在其他地方寻找它是合理的。

我最近正在评估人们上传到github.com的众多博客应用程序。我很快就跳过那些没有文档的应用程序，因为它们显然还没有准备好供其他人使用。保留在最后的那些有一个很好的自述文件，其中包含有关如何启动和运行应用程序的信息以及运行代码的在线示例。

Answer 3

如果我找不到说明如何使用库的好例子（和/或文档），我肯定不太可能使用它 - 只是作为一个实际问题，它会我很难弄清楚如何。但我不关心实现库本身的代码是什么样的。我不认为我选择一个库/框架而不是另一个只是因为那个库的开发人员已经展示了编写更清晰代码的能力（这就是我所理解的“恢复效果”）。

Answer 4

缺少文档和示例使我使用该特定库的可能性降低了很多。如果有问题的替代解决方案，我不值得花时间测试并试图弄清楚黑盒子是如何工作的。

Answer 5

糟糕的代码示例与糟糕的文档相结合将使我远离库，除非有令人信服的理由使用它。但是，具有 良好代码示例或良好文档的库通常值得使用。 （假设图书馆本身符合我的需要。）

Answer 6

是的，当然。每个库都应该有一个使用程序和CLI接口的简单示例（对于非常简单的库，使用<3方法和＆lt; 10个钩子，一个例子就足够了。“

为什么你的框架“看起来很棒”如果难以使用，即使原始编码人员使用它也会犯错误？

Answer 7

这对我来说当然很重要。编码草率/不完整和沟通不畅的证据降低了我对实际实现代码稳定和稳健的信心。

Answer 8

我自己是的，但是那里的人肯定不会因此而被关闭，否则很多开源项目很久以前就已经死了。