Als «documentation» getaggte Fragen

Die Softwaredokumentation ist geschriebener Text, der der Computersoftware beiliegt. Es wird erklärt, wie die Software funktioniert, wie sie installiert wird, wie sie verwendet wird und andere Hilfsmittel.

6
Wie dokumentiere ich meinen Code für eine Überprüfung mit minimalem Zeitaufwand? [geschlossen]
Geschlossen . Diese Frage muss gezielter gestellt werden . 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 im vergangenen Jahr . Ich möchte meinen Code so dokumentieren, dass …
8
Sollten Sie alles oder nur die meisten dokumentieren?
Es scheint ein wenig umstritten zu sein, alles zu dokumentieren, einschließlich der "JavaBean" -Syntax von Gettern und Setzern für Felder: Die Leute sagen, dass es unnötig lange und sich wiederholende DRY-Unterbrechungen gibt (wiederholen Sie sich nicht) , dass die Namenskonvention alles erklären sollte , und es wirft Code / Dokumentation. …
6
Werden Unit-Tests wirklich als Dokumentation verwendet?
Ich kann nicht zählen, wie oft ich Aussagen im Sinne von "Komponententests sind eine sehr wichtige Quelle für die Dokumentation des getesteten Codes" gelesen habe. Ich leugne nicht, dass sie wahr sind. Persönlich habe ich sie jedoch noch nie als Dokumentation verwendet. Für die typischen Frameworks, die ich verwende, dokumentieren …
4
Wie dokumentiere ich die Struktur eines Java-Programms?
Hintergrund: Meine Mitarbeiter und ich schreiben einen Artikel für eine akademische Zeitschrift. Im Zuge unserer Recherche haben wir ein Simulationsprogramm in Java geschrieben. Wir möchten das Simulationsprogramm für andere Benutzer frei verfügbar machen. Wir haben uns entschieden, den Code in einem GitHub-Repository zu hosten. Um anderen die Verwendung zu erleichtern, …
1
Dokumentation über Schnittstellenimplementierungen duplizieren / gut oder schlecht überschreiben?
Wir haben also eine Schnittstelle wie diese /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Kürzlich haben wir eine Dokumentationsstory gespielt, …
6
Alter Programmierer verschwand. Über einen anderen Programmierer einstellen. Wie gehe ich das an? [geschlossen]
Geschlossen . Diese Frage ist meinungsbasiert . 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 6 Jahren . Nachdem ich über ein Jahr lang mit WordPress und …
4
Dokumentation der mathematischen Logik im Code
Manchmal, wenn auch nicht oft, muss ich mathematische Logik in meinen Code einfügen. Die verwendeten Konzepte sind meist sehr einfach, aber der resultierende Code ist nicht - viele Variablen mit unklarem Zweck und einige Operationen mit nicht so offensichtlicher Absicht. Ich will damit nicht sagen , dass der Code nicht …
6
Selbstdokumentierender Code gegen Javadocs?
Vor kurzem habe ich daran gearbeitet, Teile der Codebasis, mit denen ich mich derzeit befasse, zu überarbeiten - nicht nur, um sie selbst besser zu verstehen, sondern auch, um es anderen zu erleichtern, die an dem Code arbeiten. Ich neige dazu, mich auf die Seite des Denkens zu lehnen, dass …
11
Was sollten Sie für Ihre Nachfolger hinterlassen?
Angenommen, Sie sind ein einziger Entwickler, der einen Job verlässt. Welche Art von Informationen / Material sollten Sie außerhalb des Codes selbst erstellen und für Ihre Ersetzung zurücklassen? Eine offensichtliche Antwort ist "was auch immer Sie sich für einen neuen Job wünschen", aber es ist schon eine Weile her, dass …
2
Welcher Standard hat 830-1998 abgelöst?
Ich habe mich mit der formaleren Dokumentation von Softwareprojekten befasst und IEEE 830-1998: Empfohlene Vorgehensweise für Softwareanforderungsspezifikationen kennengelernt . Wie Sie diesem Link entnehmen können, wurde er jedoch ersetzt. Ich weiß, dass 830-1998 und wahrscheinlich sogar 830-1993 für die Verwendung wahrscheinlich in Ordnung sind. Ich würde jedoch gerne wissen, welcher …
5
Wie werden Mindestsystemanforderungen festgelegt?
Wir haben alle unzählige Beispiele für Software gesehen, die mit "Mindestsystemanforderungen" wie der folgenden geliefert wird: Windows XP / Vista / 7 1 GB RAM 200 MB Speicher Wie werden diese allgemein bestimmt? Offensichtlich gibt es manchmal bestimmte Einschränkungen (wenn das Programm 200 MB auf der Festplatte benötigt, ist dies …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.