Wie können Sie es anderen ermöglichen, Ihrem Code zu vertrauen und ihn zu verwenden?

Question

Ich schreibe von Zeit zu Zeit Hobby-Code. Das Problem ist, dass diese Tools, Klassen oder winzigen Code-Bibliotheken in einem Flash-Stick mit hoffnungsloser Zukunft landen! Ich würde meine Projekte gerne weiterentwickeln und andere Programmierer auf sie vertrauen lassen. Wenn Sie etwas verwenden würden, das Sie im Internet gefunden haben, worauf würden Sie bei diesem Programmiertool oder dieser kleinen Bibliothek am meisten Wert legen? z.B. wäre eine separate Dokumentation für Sie ein Muss?

---

Vielen Dank an alle Mitwirkenden. Ich werde mein Bestes tun, um das Gesagte zusammenzufassen. Sie können die Liste gerne ändern. Korrekturen und Ergänzungen sind mehr als willkommen :)

• Starten Sie einen Blog und lassen Sie andere wissen, dass Sie hier sind.

• Wählen Sie die meisten geeignete Lizenz. Möglicherweise sind Open Source-Lizenzen sind die besten für Hobby-Projekte.

• Bringen Sie Ihr Projekt dorthin, wo Menschen es erreichen können. Erwägen Sie google-code , github , sourceforge oder andere Standorte.

• Verwenden Sie die öffentliche Versionskontrolle und Bug-Tracker, so können andere den neuesten Quellcode Ihres Projekts erwerben und kompilieren und verwenden.

• Schreiben Sie eine anständige Dokumentation, neben Kommentierung des Codes natürlich natürlich. Die Dokumentation sollte den Zweck der Bibliothek erklären und zumindest einfache Beispiele enthalten.

• Schreiben Sie Tests, wenn Sie bereit sind, echten Code zur Verfügung zu stellen.

• Wenn Sie eine Bibliothek aufbauen, setzen Sie eine viel Mühe in die Entwicklung einer stabilen Schnittstelle.

Answer 1

Ich überlasse es den Leuten, meinem Code in einer Reihe von Projekten zu vertrauen, aber ich dränge die Leute dazu, ihre eigenen Tests zu machen und zu pflegen, und ich stelle sicher, dass Ich bin Inhalt mit den Einheitstests.

Dokumentation ist immer gut, aber ich habe keine Zeit, so viel zu tun, wie ich gerne möchte. Aber es ist hilfreich, dass der Autor relativ leicht zu erreichen ist.

Answer 2

Das Einstellen in ein Open-Source-Repository wie code.google.com oder sourceforge.net ist wahrscheinlich der beste Anfang...

Um die Aufmerksamkeit auf sich zu lenken, sollten Sie als Nächstes den Zweck der Bibliothek/Anwendung klar und prägnant dokumentieren, wie in einer der obigen Antworten skizziert.

Endlich findet ein Austausch zwischen Bloggern und Direktwerbern statt...

Answer 3

Ein Grund, warum die Dokumentation dazu beiträgt, dass Menschen Ihrem Code vertrauen, ist, dass sie wissen, ob eine bestimmte Funktion etwas ist, das Sie beabsichtigt die der Code tun soll (und die Sie, wenn alles andere gleich bleibt, in zukünftigen Versionen des Codes beibehalten werden), oder etwas, das der aktuelle Code zufällig tut, das sich aber jederzeit als Nebeneffekt einer Fehlerbehebung oder eines Refactors ändern kann.

Manche Leute ziehen es vor, herauszufinden, was der Code wirklich tut, indem sie ihn sich ansehen, und das ist in Ordnung, aber die Dokumentation sagt Ihnen (a) was der Code tun soll, und mit etwas Glück (b) was die nächste Version des Codes tun wird. Wenn ich Ihren Code langfristig verwenden und Bugfix-Updates annehmen möchte, muss ich wissen, dass Sie eine Schnittstelle entwickelt haben, auf die ich mich verlassen kann und an die Sie sich halten wollen. Sie zu dokumentieren ist ein starker Hinweis darauf, dass Sie das zumindest versuchen.