Autor: Björn

Wie bringe ich mich selbst zum Kommentieren meines Codes?

Man ist ja selbst etwas faul. Meist weiß man, was sein Code so macht (oder besser machen sollte) und man kommentiert daher nur sehr sporadisch. Wenn man den Code dann eine Weile später wieder zur Hand nimmt, fällt es einem oft schwer seinen alten Code zu verstehen.
Daher gibt es Kommentare, in C# in Form des „<summary>„-Tags. Drei Slashes und Visual Studio fügt schon automatisch das Grundgerüst ein.
Damit nun auch wirklich jede public / internal Methode / Property kommentiert wird, muss man den Kompiler sagen, dass er fehlende Summaries als Fehler an erkennen soll.

Dazu geht ihr in die Projekteigenschaften und aktiviert unter dem Reiter „Erstellen“ den Hacken bei „XML-Dokumentationsdatei“. Nun erstellt er euch aus den Kommentaren bei jedem Build eine solche XML-Datei. Im Editor wird nun auch schon angemeckert, dass die XML-Kommentare fehlen. Um euch nun wirklich zu zwingen, sollte die Solution gar nicht erst gebaut werden, wenn die Kommentare fehlen. Das Fehlen wird als Warning gemeldet, daher sagen wir den Kompiler einfach, er soll Warnings als Fehler behandeln.
Dies geschieht ebenfalls in den Projekteigenschaften unter „Erstellen“. Evtl. kann man das noch verfeinern, indem man nur bestimmte Warnungen als Fehler behandelt, jedoch konnte ich auf die schnelle keine entsprechenden Informationen dazu finden. Ich versuche diese nachzureichen.

Von nun an lässt sich die Solution also nicht mehr kompilieren, sofern nicht überall Kommentare verfasst wurden. Um sich das Leben an dieser Stelle deutlich einfacher zu machen, empfehle ich die kostenlose Visual Studio Erweiterung GhostDoc. Mit ihr könnt ihr per Rechtsklick oder Tastenkombination eure Methode oder Property kommentieren. Dabei werden zum Beispiel schon vorhandene Kommentare aus Interfaces über Überladungen übernommen. Ansonsten erstellt er anhand des Methodennamen eine entsprechende Dokumentation. Man kann sich auch eigene Templates anlegen (habe ich mir sagen lassen). Gebündelt mit einem ordentlichen Programmierstil (bei der Namensgebung) kann man so bestimmt 80% automatisch kommentieren. Eine unglaubliche Zeitersparnis.

WinMerge mit AnkhSVN nutzen

Sollte jemand von euch AnkhSVN in Visual Studio nutzen und ihr möchtet eure Dateien mit WinMerge vergleichen oder mergen, dann müsst ihr unter Optionen -> Source Control -> Subversion User Tools folgende Befehle angeben

C:\Program Files (x86)\WinMerge\WinMergeU.exe /x /e /wl /ub /dl "$(BaseName)" /dr "$(MineName)" "$(Base)" "$(Mine)"

C:\Program Files (x86)\WinMerge\WinMergeU.exe /x /e /wl /ub /dl "$(TheirName)" /dr "$(MineName)" "$(Theirs)" "$(Mine)" "$(Merged)"

Den Merge-Befehl (der zweite) habe ich noch nicht getestet. Wichtig ist, dass die Anführungszeichen setzt. Sonst gibt es Probleme bei Leerzeichen und WinMerge will irgendwelche Verzeichnisse anstatt Dateien öffnen.

Star Wars – Thrawn Triologie

Es ist ja schon ein paar Tage her, dass ich mein letztes Star Wars Buch gelesen habe. Daher habe ich in den letzten Wochen mal zwischendurch zwei Wochenenden bei schönen Wetter genutzt und die noch verbleibenden Bücher der Thrawn-Triologie zu lesen. Während meine Freundin Blümchen pflanzte, konnte ich so ungestört in die Welt von Luke Skywalker abtauchen und bin doch sehr überrascht, wie sehr es mich mal wieder gefesselt hat. Für Die dunkle Seite der Macht (praktisch Episode 8) und Das letzte Kommando (praktisch Episode 9) hab ich nur ca. 40 Stunden gebraucht. Also für mich ist das mit rund 500 Seiten pro Buch doch sehr schnell.
Im großem und ganzen war ich sehr zufrieden mit der Handlung aller drei Bücher. Sie erzählt die Geschichte rund um Luke, Leia und Han glaubhaft weiter. Es kommen viele bekannte Namen vor, wenn auch sie nicht in den Filmen vor kamen.
Was mir negativ aufgefallen ist, und auch einigen anderen, wenn man sich zum Beispiel die Amazonrezessionen anschaut, sind die Fehler in der deutschen Übersetzungen. Das fängt mit Kleinigkeiten an, wie wenn aus „Han Solo“ mal „Hand Solo“ wird bis zu Sätzen, welche selbst nach dem fünften Mal lesen keinen Sinn ergeben. Teilweise vermute ich hier einfach eine schlechte Übersetzung. Ab und an schien durch die Übersetzung der Bezug zu bereits erzählten verloren gegangen zu sein. Kann aber auch an mir gelegen haben.

Dieses Problem scheint aber bei vielen (Star Wars) Büchern das Problem zu sein. Dies ist auch der Grund, warum ich die Episoden 4-6 noch nicht als Buch im Regal stehen habe. Wenn ich lese, wie auf der Macht, im englischen „Force“ genannt, dann auf einmal „Kraft“ wird, dann wird jedem eingefleischtem Star Wars Fan schlecht. Aber ich hoffe hier einfach mal, dass sich irgendwann noch mal ein Verlag erbarmt und eine ordentliche Fassung veröffentlicht. Ansonsten werde ich wohl mal zu einem englischen Original greifen.

Im Zuge meiner Nachbestellung ist mir übrigens aufgefallen, dass es einen Nachfolger zu „Darth Bane – Schöpfer der Dunkelheit„, welches ich letztes Jahr im Urlaub gelesen habe. Darth Bane – Die Regel der Zwei erzählt die Geschiche direkt im Anschluss an Teil 1 weiter. Ich habe gerade erst rund 100 Seiten gelesen, doch es verspricht sehr spannend zu werden. Vor allem weil auch schon Teil 3 in den Startlöchern steht. Aber bis Januar 2011 bleibt mir noch Zeit 😉

PS: Jeder der sich über das Star Wars Universum informieren will, dem empfehle ich Jedipedia.

Neue Aufgaben

Ist ja ein wenig ruhig geworden in letzter Zeit. Ich hatte echt mächtig viel um die Ohren und es stand viel auf dem Programm.
Die wichtigste Änderung in meinem Leben heißt wohl aktuell Arbeit. Ums kurz zu machen, habe ich nach etwas mehr als vier Jahren meinen alten Arbeitgeber verlassen und mich neuen Aufgaben zugewandt. Ich bin nun für eine Consulting tätig und arbeite aktuell in einem größeren Unternehmen hier im Umkreis.
Heute war bereits mein dritter Tag und bis jetzt bereue ich diesen Schritt nicht. Ich bin nun vollständig im C#-Bereich tätig, vorher war dies ja nur so nebenbei. Dort läuft aktuell ein riesiges Projekt, wo ich mit meinem Hobby-Programmier-Skill echt etwas hinterher hinke. Aber ich denke, dass ich es schaffen werde.

Ich nutze den Blogeintrag auch noch mal, um meinen alten Kollegen zu danken. Hätte nicht gedacht, dass der Abschied doch so schwer wird, 4 Jahre sind nun doch mal eine lange Zeit. Manchmal habe ich doch echt dran gezweifelt, ob die Entscheidung richtig war oder nicht. Obwohl meine Vorgesetzten nicht sehr erfreut waren, dass ich gehe, haben sie es dennoch sehr gelassen hingenommen und mir auch sonst keine Steine in den Weg gelegt. So läuft mein Vertrag eigentlich noch bis zum 09. Juni, jedoch war schon am 01. Juni Arbeitsbeginn beim neuen Arbeitgeber. Hier noch mal ein lieben Dank an meine alte Abteilung für das Abschiedsgeschenk.

Wm 2010 Tippspiel

Bald beginnt ja die WM 2010 in Südafrika und viele Firmen / Freunde werden sicherlich ein Tippspiel machen wollen.
Da kann ich euch nur die Seite „Excel Soccer 2010“ ans Herz legen. Dort gibt es eine riesige Exceldatei zum Herunterladen, wo ihr eure Tipps und Ergebnisse eintragen könnt.
Für alle, die das Rad nicht neu erfinden wollen!

(via OliverS)