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.

5
Vorlagen / Anforderungen für Projektvorschläge [geschlossen]
Diese Frage passt derzeit nicht zu unserem Q & A-Format. Wir erwarten, dass die Antworten durch Fakten, Referenzen oder Fachwissen gestützt werden, aber diese Frage wird wahrscheinlich zu Debatten, Argumenten, Umfragen oder erweiterten Diskussionen führen. Wenn Sie der Meinung sind, dass diese Frage verbessert und möglicherweise erneut geöffnet werden kann, …
6
Werden Kommentare als Dokumentationsform betrachtet?
Wenn ich kleine Skripte für mich selbst schreibe, staple ich meinen Code hoch mit Kommentaren (manchmal kommentiere ich mehr als ich codiere). Viele Leute, mit denen ich spreche, sagen, dass ich diese Skripte dokumentieren sollte, obwohl sie persönlich sind, damit ich bereit wäre, wenn ich sie jemals verkaufen würde. Aber …
4
Link zu relevanter Dokumentation in Fehlermeldung einfügen?
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 Erstbenutzer, daher treten viele rudimentäre Fehler auf. Ist es angebracht, Links zur Dokumentation …
1
Welche Informationen sollten in der github README.md enthalten sein?
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) einfügen und die anderen Informationen am besten im Github-Wiki platzieren?
3
Sind XML-Kommentare erforderlich?
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 bietet. Oft verwenden wir einfach GhostDoc, um generische Kommentare …
5
Ermittlung der richtigen Dokumentationsmenge
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 Entwurfsprozess - wenn es …
5
Besserer Weg, um neue Mitarbeiter auszubilden [geschlossen]
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 5 Jahren . Das Team, in dem ich mich gerade befinde, …
5
Sollte ein Methodenkommentar sowohl eine Zusammenfassung als auch eine Rückgabebeschreibung enthalten, wenn sie oft so ähnlich sind?
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 Studio mag. Es gibt jedoch eine …
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.