-
ACHTUNG - NEUES BLOG
Ab sofort steht unter http://devtyr.norberteder.com mein neues Blog zur Verfügung. Dieses Blog wird nicht weiter betreut, bleibt aber erhalten. Neue Eintr%auml;ge erfolgen nur mehr im neuen Blog. Kommentare werden ebenfalls nicht mehr behandelt. Wer weiterhin meinen Einträgen und Aktivitäten folgen möchte, möge bitte RSS-Feeds, Verlinkungen etc. an die neue Location anpassen.
|
Code-Dokumentation einfach gemacht!
14.11.07 - Entwicklung, Diskussionen, Qualitätsmgmt., .NET, Grundlagen, Visual Studio, Allerlei, Tools, 3rd Party Tools Beitrag von Norbert Eder| | Die Dokumentation des Sourcecodes ist ein wichtiger - aber leider oft vernachlässigter - Bestandteil der Softwareentwickler. Vor allem Frameworks wollen gut dokumentiert werden, damit ein beliebiger Entwickler sofort damit loslegen kann, ohne sich lange einarbeiten zu müssen.
Nun ist es so, dass Visual Studio hier nicht besonders viel mitbringt. Lediglich das Schreiben der Kommentare in XML-Files, die später via IntelliSense eingebunden werden. Ein Tool zur Generierung von Hilfe-Dateien wird nicht über die IDE zur Verfügung gestellt. Aber es gibt auch andere Lösungen.
Benötigte Tools/Frameworks
Bevor mit der Generierung der Sourcecode-Dokumentation gestartet werden kann, müssen einige Frameworks/Tools installiert werden. Zentraler Bestandteil für diese Variante ist Sandcastle. Hier nun eine Liste der zu installierenden Produkte:
Hinweise: Der HTML Help Workshop ist nur für die Generierung von HTML 2.x Dokumentationen notwendig und muss nur installiert werden, wenn sich dieser noch nicht auf dem Rechner befindet.
Installation
Die ersten beiden Produkte kommen jeweils als MSI-Pakete daher. Daher sind diese sehr einfach in der Installation. Der HTML Workshop kann normal herunter geladen werden und muss nur in der Projekt-Konfiguration im Sandcastle Help File Builder in der Eigenschaft HtmlHelp2xCompilerPath angegeben werden. Nun noch GhostDoc installieren und schon ist man fast fertig.
Vorarbeiten
Wichtig ist, dass beim Build-Prozess XML-Kommentare ebenfalls generiert werden. Dazu ist die Einstellung in den Eigenschaften der jeweiligen Assemblies unter dem Punkt Build zu setzen.
Nun müssen natürlich auch noch sämtliche Kommentare geschrieben werden. Um sich viel Arbeit zu ersparen kann nun GhostDoc eingesetzt werden. Dieses unterstützt bei der Generierung der Dokumentation und liefert auch Vorschläge, die in einigen Fällen noch weiter angepasst werden müssen, aber grundsätzlich ist damit eine solide Basis geschaffen.
Generierung der Dokumentation
Mit Hilfe der Sandcastle Help File Builder GUI kann nun auf einfache Art und Weise ein Dokumentations-Projekt angelegt werden. Hierzu sind die notwendigen Assemblies anzugeben. Die vorhandenen XML-Dateien werden automatisch hinzugeladen und müssen daher nicht extra angegeben werden.
Wurden nun beispielsweise Frameworks á la NUnit, NLog etc. verwendet wird der Builder beim Ausführen beanstanden, dass referenzierte Assemblies nicht gefunden werden können. Anstatt diese über Add hinzuzufügen, empfiehlt es sich, diese im Builder unter Dependencies einzupflegen.
Nun müssen noch Einstellungen getroffen werden, welche Templates für Generierung verwendet werden, ob 1.x, 2.x generiert werden soll, oder gar eine Website und viele weitere Einstellungen wie Überschriften usw.
Ein wichtiger Punkt ist unter Namespaces zu finden: Hier ist es möglich einzustellen, welche Namespaces in der Dokumentation aufscheinen und es kann zusätzlich eine Beschreibung für diese eingegeben werden.
Wurde alles konfiguriert, kann die Generierung gestartet werden. Diese dauert zwar ein wenig länger als man erwartet, dafür ist das Ergebnis (vorausgesetzt es wurde brav dokumentiert) sehr fein und kann für die Weitergabe oder interne Verwendung herangezogen werden.
Fazit
Mit Hilfe dieser wenigen Tools und ca. 10 - 15 Minuten Installation und Konfiguration kann ein komplettes Dokumentations-System aufgesetzt werden. Die Dokumentation selbst kann uns leider niemand abnehmen, aber das soll keine Ausrede sein. Ich persönlich setze obige Kombination schon länger ein und bin bis dato sehr zufrieden.
Sicherlich wird es Möglichkeiten geben, dies weiter zu verbessern, wer hier also eine andere Konfiguration einsetzt bzw. Vorteile für seine Lösung anbieten kann, der sei hiermit eingeladen, mir dies mitzuteilen. Ebenfalls würde mich interessieren, ob ihr Code-Dokumentationen schreibt, oder nicht, inklusive einer kurzen Begründung.
| | | Kommentar hinzufügen
| 0 Trackbacks
| Permalink | Trackback-URL |
Local History Feature unter Visual Studio 2005
13.11.07 - .NET, Visual Studio, Tools, 3rd Party Tools Beitrag von Norbert Eder| | Unter Eclipse gibt es ein nettes Feature welches sich Local History nennt. Beim Speichern einer geänderten Klasse wird im Hintergrund ein Version dieser Datei mit Zeitstempel in einen History-Container gelegt. Werden nun erneut Änderungen gemacht, die eventuell umfangreich sind und durch einen Gedankenfehler eventuell rückgängig gemacht werden wollen (inzwischen bereits einige Male gespeichedrt), kann eine alte Version aus der lokalen History bezogen werden und der alte Stand ist somit wieder hergestellt.
Diese Funktion fehlt bei Visual Studio und daher hatte ich bereits an ein kleines Projekt diesbezüglich gedacht. Glücklicherweise habe ich mich jedoch vorher auf die Suche gemacht und ein wirklich nettes Add-In für Visual Studio gefunden:
Visual Local History 2005
Aufgepasst: Das Add-In ist noch im Beta-Stadium und daher ist Vorsicht geboten.
| | | Kommentar hinzufügen
| 0 Trackbacks
| Permalink | Trackback-URL |
BlogEngine.NET aufgebohrt ...
08.10.07 - .NET, Datenverwaltung, Allerlei, Internet, Tools, 3rd Party Tools Beitrag von Norbert Eder| | Diejenigen, die sich die neue Website von DasBackup genauer angesehen haben, bemerkten vermutlich, dass ich BlogEngine.NET dafür eingesetzt habe. Teils aus Interesse, teils weil ich vernommen hatte, dass BlogEngine.NET wirklich sehr NETt sein soll.
Nun gut. Meine Erfahrung bei der Umsetzung der neuen Webpräsenz hat eigentlich eine Bestätigung gebracht. Wirklich ein sehr feines Teil. Daraufhin schoss gleich der nächste Gedanke ein. Eine Portierung dieses Blogs auf BlogEngine.NET. Nun gut. BlogEngine.NET unterstützt blogML. Zusätzlich gibt es ein Importer-Tool, welches via ClickOnce geladen wird (Achtung Firefox User: hier muss FFClickOnce installiert sein). Zur Auswahl steht der Import von blogML als auch RSS.
Problem Nr. 1: Der RSS-Import funktioniert bei mir nicht. Es handelt sich angeblich um ein invalides RSS. Sehr fein. Alles andere kann mit diesem Feed umgehen, nur das Importer-Tool nicht. Also scheidet dieser Weg hiermit aus.
Problem Nr. 2: Woher nun ein blogML-File bekommen? Schnell eine Solution angelegt, die blogML-DLL eingebunden und flux einen Importer geschrieben, welcher aus sämtlichen Inhalten des Blogs ein blogML-File generiert. Möööööööööp. Wieder nichts. Es validiert, wird aber nicht importiert. Feine Sache.
Und nun? Ich bin zwar immer noch von BlogEngine.NET begeistert, dennoch verstopfen sich zunehmends meine Nebenhöhlen. Was lernt man daraus? In der EDV ist dann doch nicht alles so einfach wie angenommen. Aber sollte ich das Problem lösen, dann werde ich das Tool natürlich für all die anderen SimplePHPBlog-User da draussen veröffentlichen, die eventuell auf ein System umsteigen möchten, das blogML unterstützt (BlogEngine.NET, WordPress etc.).
| | | 4 Kommentare
- 966 mal angesehen
| 0 Trackbacks
| Permalink | Trackback-URL |
DasBackup mit neuer Webpräsenz
07.10.07 - .NET, Internet, Tools, DasBackup Beitrag von Norbert Eder| | Seit längerer Zeit auf der TODO-Liste, doch jetzt endlich geschafft, die neue Webpräsenz für DasBackup. Bei DasBackup handelt es sich um ein einfach zu verwendetes Backup-Tool mit vielen Features. Jetzt wurde die Website auf einen aktuellen Stand gebracht.
Die neue Version von DasBackup wird ebenfalls in den nächsten Wochen erscheinen und wird viele neue Funktionalitäten bieten. Weitere Informationen werden auf der Projekt-Website zukünftig vermittelt.
| | | Kommentar hinzufügen
| 0 Trackbacks
| Permalink | Trackback-URL |
Google Analytics offline nutzen
28.09.07 - Internet, Tools, 3rd Party Tools, Kunterbunt Beitrag von Norbert EderDie ultimativen Tools für Entwickler und Power User
28.08.07 - Tools, 3rd Party Tools Beitrag von Norbert EderBackup Tool für Windows Live Mail
16.08.07 - Tools, 3rd Party Tools Beitrag von Norbert Eder| |  Wer Windows Live Mail einsetzt, der wird wohl eine Backup-Funktion vermissen. Dieses kleine Tool bietet die Möglichkeit von Backups für Live Mail an. Die Software ist auf die minimalen Anforderungen beschränkt, ohne Schnick-Schnack. Ideal um schnell Mal ein Backup zu ziehen. Eine Wiederherstellung kann natürlich ebenfalls schnell durchgeführt werden.
Weitere Informationen im Live Blog
| | | Kommentar hinzufügen
| 0 Trackbacks
| Permalink | Trackback-URL |
dasBlog 2.0 veröffentlicht
16.08.07 - .NET, ASP.NET, Tools Beitrag von Norbert EderDesktopCleaner: Version 1.0.6 veröffentlicht
01.08.07 - Tools, DesktopCleaner Beitrag von Norbert Eder| | Ab sofort ist die Version 1.0.6 des Tools DesktopCleaner verfügbar. Es handelt sich hierbei um eine Bugfix-Version, in der einige gemeldete Fehler behoben wurden.
Änderungen
- [Fehler] Bei Clean Desktop kam es zu einem Fehler, wenn Verzeichnisse über unterschiedliche Volumes verschoben werden sollten. Dies wurde behoben.
- [Verbesserung] DesktopCleaner wird nun nach dem ersten Start immer verkleinert gestartet.
- [Verbesserung] Über das Kontextmenü ist nun ein About Screen verfügbar, der Kontaktmöglichkeiten, als auch die aktuelle Versionsnummer anzeigt.
Download DesktopCleaner 1.0.6
| | | Kommentar hinzufügen
| 0 Trackbacks
| Permalink | Trackback-URL |
Desktop Cleaner 1.0.5 verfügbar
26.07.07 - Tools, DesktopCleaner Beitrag von Norbert Eder| | Das ging ja richtig flott mit der neuen Version von Desktop Cleaner. Die neue Version enthielt eine kleine, aber nicht unwichtige Verbesserung.
Ab sofort ist es möglich, über die Advanced Settings einzustellen, ob der Desktop Cleaner beim Systemstart automatisch mitgestartet werden soll. Schließlich müsste der User sonst selbst daran denken, die Anwendung zu starten.
Es besteht die Möglichkeit die Option für den aktuellen User, für die gesamte Maschine oder gar nicht zu wählen.
Download Desktop Cleaner 1.0.5
Vielen Dank an Mariusz für diesen nützlichen Hinweis.
PS: Eine Anpassung der Dokumentation wird noch vorgenommen und in Bälde nachgereicht.
Projektseite Desktop Cleaner
Da der Desktop Cleaner innerhalb sehr kurzer Zeit sehr viele Downloads erfahren hat, habe ich eine eigene Projektseite für dieses kleine Tool eingerichtet.
| | | 3 Kommentare
- 1656 mal angesehen
| 0 Trackbacks
| Permalink | Trackback-URL |
Zurück Weiter
|
|
|
|
|
|
|
;)
;)
;)
;)
;)
;)
;)
