Machen schlechte Code-Beispiele Sie von Bibliotheken fern?

Question

Ich habe einen Rahmen evaluiert, der auf dem Papier gut aussieht. Das Problem ist, dass der Beispielcode unvollständig und von schlechter Qualität ist. Die mitgelieferten Referenzimplementierungen sind größtenteils nicht zur Verwendung gedacht (also können sie auch als Beispielcode betrachtet werden) und haben es nur geschafft, mich zu verwirren.

Ich weiß, dass es üblich ist, dass Dinge auf dem Papier besser aussehen, aber meine Erfahrung mit dem Beispielcode macht mich von weiteren Untersuchungen ab.

Lassen Sie schlechte Code-Beispiele Ihre Beurteilung von Frameworks/Bibliotheken ändern? Bis jetzt war meine Erfahrung ähnlich dem "Wiederaufnahmeeffekt": wenn jemand nicht die Mühe in Rechtschreibprüfung ihren Lebenslauf setzt, werden sie wahrscheinlich den Job nicht bekommen ...

Answer 1

Schlechte Codebeispiele in Kombination mit mangelhafter Dokumentation werden mich von einer Bibliothek abweisen, es sei denn, es gibt einen zwingenden Grund, sie zu verwenden. Allerdings ist eine Bibliothek, die entweder hat gute Codebeispiele oder gute Dokumentation ist es normalerweise wert, zu verwenden. (Vorausgesetzt, dass die Bibliothek selbst meine Bedürfnisse erfüllt.)

Answer 2

Für mich tut es. Ich möchte Bibliotheken vermeiden, in denen die Codebeispiele unvollständig sind. Wenn die Bibliothek Open Source ist, werde ich es übersehen, da ich den Code direkt ansehen kann und sehe, ob die Interna der Bibliothek vernünftig sind, und ich weiß, dass ich (falls ich es tun musste), falls es ein Problem geben sollte, das Problem beheben kann es.

Wenn die Bibliothek kommerziell ist und ihre Beispiele und/oder Dokumentation schlecht ist, suche ich woanders hin. Ich sehe es einfach als Risikomanagement - schlechte Proben machen mir Angst vor der Qualität der Bibliothek im Allgemeinen.

Egal, wie gut etwas auf dem Papier oder in der Theorie ist, kann es immer noch Mist sein, wenn programmiert.

Answer 3

Ich selbst, aber da müssen Leute da draußen sein, die nicht ausgeschaltet sind, sonst gibt es viele Open-Source-Projekte, die vor langer Zeit gestorben wären.

Answer 4

Wenn ich keine guten Beispiele (und/oder Dokumentationen) finden kann, die veranschaulichen, wie die Bibliothek zu verwenden, bin ich definitiv weniger wahrscheinlich, es zu verwenden - nur als eine praktische Angelegenheit wird es für mich schwerer um herauszufinden, wie. Aber es ist mir egal, was der Code implementiert die Bibliothek selbst aussieht. Ich glaube nicht, dass ich eine Bibliothek/ein Framework einem anderen vorziehen würde, nur weil die Entwickler des einen die Fähigkeit gezeigt haben, saubereren Code zu schreiben (was ich unter dem "Resume-Effekt" verstehe).

Answer 5

Ja, definitiv. Jede Bibliothek sollte mit einem einfachen Beispiel mit Programm und einer CLI-Schnittstelle kommen (für sehr einfache Bibliotheken mit <3 Methoden und < 10 Haken, sollte ein Beispiel ausreichen).

Und warum sieht Ihr Framework "gut aus", wenn es so schwer zu benutzen ist, dass sogar die ursprünglichen Programmierer Fehler machen?

Answer 6

Ich denke, das ist ein guter Grund, sich von anderen Bibliotheken abzuwenden und zu bewerten. Als potentieller Benutzer einer Bibliothek erweckt ein Mangel an Dokumentation und/oder fehlerhaften Codebeispielen den Eindruck, dass die Bibliothek noch nicht reif genug für die Nutzung durch Dritte ist. Mit der Zeit wird es vielleicht die fehlenden Stücke gewinnen, aber bis dahin halte ich es für sinnvoll, woanders hinzuschauen.

Ich habe vor kurzem die Vielzahl von Blogging-Anwendungen, die Menschen auf github.com hochgeladen haben, bewertet Ich übersprang schnell diejenigen, die keine Dokumentation, wie sie offensichtlich nicht bereit für andere zu verwenden waren. Diejenigen, die am Ende übrig blieben, hatten eine gute README mit Informationen darüber, wie man die App zum Laufen bringen konnte, sowie ein Online-Beispiel für den laufenden Code.

Answer 7

Mangel an Dokumentation und Beispielen macht es mir viel weniger wahrscheinlich, diese bestimmte Bibliothek zu verwenden. Es lohnt sich nicht, meine Zeit zu testen und herauszufinden, wie eine Blackbox funktioniert, wenn es alternative Lösungen für das Problem gibt.

Answer 8

Es ist mir wichtig. Beweise für schlampige/unvollständige Codierung und schlechte Kommunikation verringern mein Vertrauen, dass der tatsächliche Implementierungscode stabil und robust ist.