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...
Wenn ich einen Code habe, der mathematisch oder strukturell recht komplex und irreduzibel ist, wie würde ich diesen Code dokumentieren? Wie kann ich insbesondere sicherstellen, dass jemand, der möglicherweise nicht über die mathematischen oder architektonischen Fähigkeiten verfügt, die ich habe,...
Ich habe (beiläufig) semantische / ontologiebasierte Ansätze zur technischen Dokumentation untersucht, als ich auf dieses Juwel gestoßen bin : Literate Programming und das Semantic Web sind Ideen aus verschiedenen Zeiten, die einen Zusammenhang haben. Das verlinkte Papier Literate Programming in...
Erstens ist mir klar, dass diese Frage etwas lang und vage sein kann, und ich entschuldige mich dafür. Dies ist wahrscheinlich ein grundlegendes Problem mit einem kurzen Namen für jeden, der es "verstanden" hat, aber da mir diesbezüglich etwas fehlt, bitte beschreiben Sie das Problem mit mir. Ich...
Ich bin daran interessiert zu sehen, wie andere Leute das tun. Insbesondere in Situationen, in denen mehrere verschiedene Clients dieselbe Softwarebasis mit leicht unterschiedlichen Geschäftsregeln verwenden. Welche Art von Praktiken verwenden Sie, um zu dokumentieren, wie alles funktionieren soll,...
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...
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 vor 4 Jahren . Warum binden wir...
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 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,...
Oft löse ich Fehler, indem ich die Antwort auf Stack Overflow finde. Ist es eine schlechte Praxis, einen Ausschnitt darüber hinzuzufügen, warum ich das getan habe, was ich getan habe, und dann einen Link zu einem Artikel oder einer Seite aus dem Web
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 5 Jahren . Mein Team hat...
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten .
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...
Ich habe einige quantitative Bibliotheken in C # entwickelt, in denen es wichtig ist, nicht nur die klassischen Informationen zu verstehen, die zu den XMLDoc-Kommentaren gehören (die grundlegende Informationen mit der Methodensignatur enthalten), sondern auch die mathematischen Formeln, die in den...
Ein Kollege von mir war einmal auf einem Seminar über agile Entwicklung, wo er hörte, dass es möglich ist, Unit-Tests als technische Dokumentation zu verwenden. So etwas wie die Verwendung von Komponententests als Beispiel für die Verwendung der Klasse. Eine schnelle Google-Suche lieferte TDD und...
Geschlossen. Diese Frage ist nicht zum Thema . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so dass es beim Thema für Software Engineering Stapel Börse. Geschlossen vor 4 Jahren . Vor kurzem wurde mir die Aufgabe übertragen, ein...
Was wäre eine gute Alternative zur Inline-Java-Dokumentation, dh kann man eine separate Dokumentdatei haben, die irgendwie einer Java-Quelldatei zugeordnet ist? Ich habe noch nie große Kommentarbereiche mit Code
Ich arbeite derzeit an einer Set-Implementierung in JavaScript. Dies sollte Generika simulieren, wie sie aus Java oder C # bekannt sind. Ich benötige eine veränderbare Version davon (ermöglicht das Hinzufügen / Entfernen von festgelegten Werten) und eine unveränderliche. Meine Konstruktorsignatur...
Ich versuche, eine Software zu dokumentieren, die ich ausführlich geschrieben habe. Eine SAS ist zu hoch und deckt die API nicht ab. Ich habe einige Beispiele für ein Sicherheitsdatenblatt online gefunden, sehe aber keinen Trend in ihrem Format. Ich frage mich, ob es einige allgemeine Richtlinien...