Ich bin einer dieser Entwickler, die der Meinung sind, dass der geschriebene Code selbsterklärend sein und wie ein Buch gelesen werden sollte. Bei der Entwicklung von Bibliothekscode für andere Benutzer versuche ich jedoch, so viel Dokumentation wie möglich in die Header-Dateien aufzunehmen. was...
Ich frage mich, was eine Algorithmusdokumentation enthalten sollte. Ich kann keine richtige Richtlinie finden, der ich folgen kann. Ich habe vor, aufzunehmen Zusammenfassung des Algorithmus Beschreibung des Algorithmus Flussdiagramme Pseudocodes Beispiel-Eingabedatensatz (mehrfach) Ausgabedaten...
Es scheint mir, dass Sie unmöglich eine Softwarespezifikation in Englisch schreiben können, die völlig frei von Mehrdeutigkeiten ist, einfach aufgrund des informellen Charakters der natürlichen Sprache - und daher muss eine wirklich eindeutige Spezifikation Code enthalten, der in einer formal...
Ein zentraler Bestandteil von Domain Driven Design ist die konsistente Verwendung einer allgegenwärtigen Sprache im gesamten System - in Konversationen, Code, Datenbankschema, Benutzeroberfläche, Tests usw. Ich bin an einem Projekt beteiligt, in dem es bereits eine etablierte Domain-Sprache gibt,...
Ich bin ein Befürworter von ordnungsgemäß dokumentiertem Code und bin mir der möglichen Nachteile bewusst . Das liegt außerhalb des Rahmens dieser Frage. Ich befolge gerne die Regel, XML-Kommentare für jedes öffentliche Mitglied hinzuzufügen , wenn man bedenkt, wie sehr ich IntelliSense in Visual...
Geschlossen . Diese Frage muss fokussierter sein . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so, dass sie sich nur auf ein Problem konzentriert, indem Sie diesen Beitrag bearbeiten . Geschlossen...
Wo ich derzeit arbeite, ist der allgemeine Ansatz - Vermeiden Sie die Dokumentation so weit wie möglich Dokumentieren Sie nur, wenn ein anderes Team es benötigt Nur zur Verdeutlichung meine ich nicht die Codedokumentation - das tun wir, ich meine die gesamte Dokumentation rund um den...
Momentan verwenden wir in meinem aktuellen Projekt agile Methoden, und wir haben jede Menge solcher Geschichten: Als Assistent möchte ich einem Kunden eine Rückerstattung zahlen, damit er auf Anfrage etwas Geld bekommen kann Als Kunde möchte ich für einen Kauf bezahlen, damit ich meinen Artikel...
Ich bin ein Amateurentwickler und alle meine bisherigen Programme waren einfach genug, um im Code dokumentiert zu werden. Beim Lesen des Codes war klar, was ich so und so tat (mein Standardtest bestand darin, den Code 6 Monate später zu betrachten und beim ersten Lesen alles zu verstehen - und ich...
Wir erstellen eine kommerzielle Bibliothek und Codebeispiele, die von externen Entwicklern verwendet werden. Wir haben eine (geschlossene, registrierten Benutzern zur Verfügung stehende) Dokumentation, in der ausführlich erläutert wird, wie die Bibliothek verwendet wird. Viele der Entwickler sind...
Früher war ich ein Fan davon, XML-Kommentare für die Dokumentation zu benötigen. Ich habe meine Meinung seitdem aus zwei Hauptgründen geändert: Wie guter Code sollten Methoden selbsterklärend sein. In der Praxis sind die meisten XML-Kommentare nutzloses Rauschen, das keinen zusätzlichen Wert...
Ich habe meinen Code für dokumentiert doxygen, möchte aber nicht den Standard-HTML- Code , den er enthält. Ich weiß, dass ich es anpassen kann, indem ich benutzerdefiniertes CSS, Kopf- und Fußzeilen usw. bereitstelle (wie es GNOME tut) und wie ich den Dateien allgemeinen PHP-Code hinzufügen und ihn...
Welche Informationen würden Sie in der Github-README erwarten? Sollte alles in die README gehen? dh Einführung Installation Versionen Benutzerhandbuch Implementierung Testen Ähnliche Resourcen Oder sollten Sie einfach bestimmte Dinge in die README-Datei (Einführung, Installation, Versionen)...
Ich arbeite an einer kleinen Bibliothek, die Implementierungen grundlegender, bekannter String-Metriken bereitstellt. Meistens für meine eigene Ausbildung. Die Entwicklung findet also immer dann statt, wenn ich etwas Freizeit habe. Aus diesem Grund habe ich die meisten Prozesse automatisiert,...
Wenn Sie also Fehler beheben, sind Sie auf einen gestoßen, der andere Module des Softwareprodukts betreffen könnte. Ihre Daten reichen nicht aus, um Ihre Behauptung über die Auswirkungen des Fixes zu stützen, und Sie wurden gebeten, ein Dokument zur Wirkungsanalyse zu erstellen. Gibt es einen...
Hat jemand Vorschläge zum Erstellen einer Flussdiagrammdarstellung einer REST-artigen Weboberfläche? Um den Mitentwicklern eine gründliche Dokumentation zur Verfügung zu stellen, habe ich mich mit der Modellierung der Schnittstelle zum Ändern und Generieren einer Produktressource beschäftigt:...
Ich möchte Javadoc auf trockene Weise schreiben. Aber das Orakel-Dokument über Javadoc sagt, dass man dasselbe noch einmal in einen Kommentar zur Überladungsmethode schreiben soll. Kann ich Wiederholungen nicht
Während eines anderen Programmierers Überprüfung Implementierung einer Funktion der Normalverteilung CDF zu berechnen , habe ich einen Vorschlag , um entweder die gesamte Implementierung mit Python eingebauten Funktionen oder verwenden SciPy, eine gemeinsame wissenschaftliche Bibliothek...
Ich bin dabei, ein Projekt zu verlassen, und bevor ich gehe, hat mein Chef mich gebeten, Code zu dokumentieren (ich habe nicht sehr gut dokumentiert). Es ist keine große Sache, das Projekt ist nicht besonders komplex. Aber ich finde in meiner Dokumentation Stellen, an denen ich sagen möchte:...
Dies bezieht sich auf eine Diskussion in einer Antwort und die Kommentare dieser Frage: Was ist mit der Abneigung gegen Dokumentation in der Branche? . In der Antwort wurde behauptet, dass "Code nicht lügen kann" und daher anstelle der Dokumentation der Anlaufpunkt sein sollte. In mehreren...