Code Dokumentieren–automatische Nummerierung

In letzter Zeit dokumentiere ich oft Quellcode. Die Dokumentation ist an Entwickler adressiert, die sich schnell in das Projekt einarbeiten sollen.

Dabei hat es mich ungeheuer gestört, dass ich die Nummerierung des Quellcodes manuell machen musste. Das verdirbt mir den Spaß beim schreiben. Darum habe ich ein AutoIt-Skript geschrieben, mit dem ich bestimmte Fragmente in meinem Quellcode automatisch nummerieren kann.

Sprich  aus…

public static void TuWas()
{
// ich tue ja
}
wird…

01:  public static void TuWas()
02:  {
03:   // ich tue ja
04:  }


skizzierter Ablauf:

  1. Das Skript führt automatisch den HOTKEY STRG+C auf einen beliebig markierten Text aus
  2. Jede Zeile des Textes wird in der Form “01: nummeriert.
  3. Der bearbeitet Text wird in das ClipBoard (die Zwischenablage) kopiert
  4. mit STRG+V kann der nummerierte Text in ein beliebiges Textverarbeitungsprogramm eingefügt werden.

Dieses arbeitet autark, kann allerdings in Visual Studio 2010 integriert werden, um die Produktivität während des Dokumentierens zu steigern.

Zunächst kann das Skript mit dem Namen CodeToWord hier heruntergeladen werden.
Der Download enthält

  1. die Skriptdatei zum weiterentwickeln
  2. die kompilierte Executable für x64 und x86 Betriebssysteme zum ausprobieren

Integration in Visual Studio

  1. öffnen von Visual Studio (die Version ist egal)
  2. in der oberen horizontalen Navigation auf Extras –> Externe Tools klicken
    extras-externetools
  3. im Fenster Externe Tools auf “Hinzufügen” klicken und die Executable von  CodeToWord angeben, sowie einen Namen vergeben.
    codetowordhinzufügen
  4. Unter Extras sollte CodeToWord sichtbar sein.
    externes tool in vs
  5. Nun unter Extras auf Anpassen klicken.
    shortcut einfügen 1
  6. Im Anpassen– Fenster auf “Tastatur…” klicken
    shortcut einfügen 2
  7. Im Optionen…– Fenster in das obere Textfeld “Externer” eingeben.
    Die darunter liegende liste zeigt dann eine Liste an (“Extras.ExternerBefehl1”).
    Sofern dies das erste externes Tool ist –> ExternerBefehl1 auswählen und einen ShortCut zuweisen.
    Hier wurde ALT+C vergeben.
    -> Mit “OK” bestätigen.
    shortcut einfügen 3
  8. Unter Extras ürüfen, ob ShortCut vorhanden ist.
    shortcut einfügen 4
  9. Beliebigen Text in einer Quellcode- Datei markieren und ALT+C drücken.
    markcode and press alt c
  10. Ein Textverarbeitungsprogramm öffnen und Quelltext mit STRG+V einfügen.
    pastecode into word

Fertig!

Viel Spaß beim Dokumentieren wünscht
Gregor

Gregor

Gregor Woiwode ist Angestellter der heco GmbH, wo er als Sofwareentwickler und Trainer tätig ist. Sein Fokus liegt in der Erstellung von Webportalen mit dem .NET- und Angular-Framework. Von 2007 bis 2010 studierte er Telekommunikationsinformatik an der Hochschule für Telekommunikation in Leipzig und schloss den Studiengang als Bachelor of Engineering ab. Derzeit studiert er im Studiengang Wirtschaftsinformatik um die Auszeichnung Master of Science zu erhalten.

What do you think? Please leave a Comment below!