21.09.2017, 09:40
(Dieser Beitrag wurde zuletzt bearbeitet: 21.09.2017, 09:58 von Mareta Dagostino.)
Softwareentwickler benutzen in der Regel eine IDE (integrierte Entwicklungsumgebung, z.B. "Visual Studio"). Die zeigt Klassenabhängigkeiten und mögliche Methoden einschließlich möglicher Attribute an: und zwar genau die Auswahl, die an der Stelle möglich ist, an der der Cursor steht. Solange da im Web nur eine automatisch generierte Gesamtliste der Klassen, Methoden und Argumente steht, sehe ich noch keinen Mehrwert.
Beispiel, hier mal in eine willkürliche Seite der MSDN Dokumentation gegriffen:
https://docs.microsoft.com/en-us/dotnet/...mework-4.7
Das meiste ist zwar auch dort automatisch generiert, aber unter "Remarks" ist eben auch erklärt, wofür die jeweilige Klasse, Methode, Struktur... gut ist. Und bei den Aufzählungen sind zweispaltige Listen, links die automatisch generierten Daten und rechts redaktionelle Kommentare.
Mal im Ernst: Eine Doku für OpenSim zu erstellen ist ein Arbeitspaket, was um ein vielfaches größer ist als einen kleinen Patch zu basteln oder ein OpenSim Anwender-Wiki zu schreiben. Außerdem, wer es schafft eine solche Doku zu schreiben, der oder die kann danach bei den Core-Devs mitmachen. Denn ohne die innere Funktionsweise von OpenSim zu verstehen, kann man das auch nicht sinnvoll dokumentieren.
@Manni: Mein Rat lautet dementsprechend "verzettele dich nicht". Dieses Projekt wäre verschwendete Lebenszeit.
Beispiel, hier mal in eine willkürliche Seite der MSDN Dokumentation gegriffen:
https://docs.microsoft.com/en-us/dotnet/...mework-4.7
Das meiste ist zwar auch dort automatisch generiert, aber unter "Remarks" ist eben auch erklärt, wofür die jeweilige Klasse, Methode, Struktur... gut ist. Und bei den Aufzählungen sind zweispaltige Listen, links die automatisch generierten Daten und rechts redaktionelle Kommentare.
Mal im Ernst: Eine Doku für OpenSim zu erstellen ist ein Arbeitspaket, was um ein vielfaches größer ist als einen kleinen Patch zu basteln oder ein OpenSim Anwender-Wiki zu schreiben. Außerdem, wer es schafft eine solche Doku zu schreiben, der oder die kann danach bei den Core-Devs mitmachen. Denn ohne die innere Funktionsweise von OpenSim zu verstehen, kann man das auch nicht sinnvoll dokumentieren.
@Manni: Mein Rat lautet dementsprechend "verzettele dich nicht". Dieses Projekt wäre verschwendete Lebenszeit.