| 

.NET C# Java Javascript Exception

9
Im letzten Beitrag habe ich eine VS2010 Extension gezeigt, mit deren Hilfe sich Bilder als Dokumentationen in den Quellcode einfügen lassen. Sah gut aus, aber war es auch praktisch? Inzwischen denke ich, Nein. Dokumentationen müssen manchmal auch angepasst werden. Und das war hier etwas umständlich. Dieses Vorgehen war zu teuer, nächster Versuch. Ziel ist es, […]

Im letzten Beitrag habe ich eine VS2010 Extension gezeigt, mit deren Hilfe sich Bilder als Dokumentationen in den Quellcode einfügen lassen. Sah gut aus, aber war es auch praktisch?

Inzwischen denke ich, Nein. Dokumentationen müssen manchmal auch angepasst werden. Und das war hier etwas umständlich. Dieses Vorgehen war zu teuer, nächster Versuch. Ziel ist es, die Dokumentation möglichst nahe am Quellcode zu haben, das ist so wie mit den Tests. Also vielleicht nur Teil des Projektes (die Solution ist schon zu weit weg). Wir können dort beliebige Dateien hinzufügen, das sieht dann beispielsweise so aus.

Hier haben wir folgende Vorteile. Wir können die Dokumentation anpassen. Wir können sie anzeigen, wenn wir das möchten und stören nicht den Lesefluss im Quellcode. Einen eigenen Projektordner würde ich in den meisten Fällen trotzdem nicht anlegen, sondern immer nach “möglichst nah am Quellcode” vorgehen. Hier als Beispiel mit dem Namen der Quelldatei welche dokumentiert wird. Das reicht aber nicht. Als nächstes sollte der Standardeditor für das Dokument angepasst werden.

Wichtig ist hier, “Als Standard” auswählen. Jetzt noch eine Extension finden, welche den “DependentUpon” Eintrag in der Projektdatei anpassen kann. Für diesen Zweck habe ich nach kurzer Suche die Extension NestIn gefunden. Die tut genau das.

Noch besser wäre ein integrierter Editor mit dem man tatsächlich arbeiten kann. Ich habe noch keinen gefunden, und nehme gerne Vorschläge entgegen. Anforderungen kommen womöglich in einem folgendem Beitrag.


tools tool documentation
Schreibe einen Kommentar:
Themen:
documentation tool tools
Entweder einloggen... ...oder ohne Wartezeit registrieren
Benutzername
Passwort
Passwort wiederholen
E-Mail