Produktbeschreibung

 

Einleitung

Das Programm SCD ist ein Tool, das Sie bei der Dokumentation Ihrer Quelltexte unterstützen soll.

Sie können SCD in Ihre IDE integrieren oder als „stand alone“ Anwendung einsetzen!

Das Ziel der Anwendung ist es Ihnen eine einfache Lösung zur Dokumentation Ihrer Methoden und Klassen im Quelltexte anzubieten. Dabei wird auf überflüssigen Schnickschnack bewusst verzichtet.

SCD wurde in Delphi für die Integration in das RAD Studio 10.x entwickelt. Es lässt sich einfach der Tool-Liste hinzufügen und ist dann direkt in die IDE integriert.

Es wird für Sie ein Kinderspiel aussagekräftige Dokumentationen zu erstellen und sie in Ihren Quelltext zu übernehmen.

Sie können selbstverständlich auch bereits erstellte Dokumentations-Einträge in die Anwendung importieren und Sie dort bearbeiten.

 

Build with Delphi

Built_for_Delphi

Installation

Eine Installation der Anwendung ist nicht notwendig. SCD wurde als „embeded“ Anwendung entwickelt und ist ohne Installation sofort einsetzbar.

Sie können die Datei „scd_32_embeded.zip“ bzw. „scd_64_embeded.zip“ einfach in das gewünschte Verzeichnis kopieren und dort entpacken. Die zip Datei enthält folgende Dateien:

scd.exe
borlndmm.dll
Software-Lizenzvertrag der Wallhalla Software UG (haftungsbeschränkt).pdf

Beispiel:
D:\Rad_Studio\      // Laufwerk und Verzeichnis des RAD Studio
D:\Tools\scd\       // Verzeichnis in das Sie die zip Datei entpacken

Um die Anwendung in die IDE zu integrieren, gehen Sie folgendermaßen vor.

    1. Starten Sie Ihr RAD-Studio bzw. Ihre Delphi oder C++ IDE.

    2. Klicken Sie im Menü Tools an und dort Tools-konfigurieren so wie in Abbildung 1 zu sehen ist.

     

    3. Im Fenster Tools-Optionen sehen Sie alle bereits installierten Tools. Klicken Sie nun auf „Hinzufügen“, um ein weiteres Tool der Liste hinzuzufügen.

     

     

     

     

     

     

     

     

     

    4. Bei den Tools-Eigenschaften vergeben Sie nun einen Titel unter dem das Tool im Menü der IDE erscheinen soll. Bei „Programm“ geben Sie an, wo Sie die Anwendung gespeichert haben. Im Beispiel oben wäre das: „D:\Tools\scd\scd.exe“. Das Arbeitsverzeichnis ist das Verzeichnis, in dem die Anwendung gespeichert ist („D:\Tools\scd\“). Das Feld Parameter können Sie leer lassen. Klicken Sie nun, nachdem Sie die Eingaben gemacht haben auf „ok“, um diese zu speichern.

     

     

     

     

     

     

    5. Im Menüpunkt Tools Ihrer IDE ist nun ganz unten ein neuer Eintrag hinzugekommen.

 

 

 

 

 

 

 

 

Einsatz

Es wird für Sie ein Kinderspiel aussagekräftige Dokumentationen zu erstellen und sie in Ihren Quelltext zu übernehmen.

Sie können selbstverständlich auch bereits erstellte Dokumentations-Einträge in die Anwendung importieren und Sie dort bearbeiten.

Das Erstellen von Dokumentations-Einträgen:

Starten Sie die SCD Anwendung und geben Sie wie im Beispiel Ihre Dokumentation in die betreffenden Abschnitte ein.

 

Sobald Sie Ihre Eingaben gemacht haben, drücken Sie F5 oder klicken Sie den kopieren Button an. Ihre Eingabe wird nun in eine Quelltext-Dokumentation umgewandelt und in die Zwischenablage kopiert.

 

 

 

Wechseln Sie in die IDE und positionieren Sie die Schreibmarke (cursor) an die Stelle an der die Dokumentation eingefügt werden soll. Am besten am Anfang der Zeile in der „function“ steht! Jetzt können Sie mit „STRG-C“ oder „Shift-Einfügen“ die Dokumentation einfügen. Halten Sie den Maus-Zeiger auf den Namen der „function“ um die Dokumentation angezeigt zu bekommen.

 

 

 

 

 

 

 

 

Sie können alle Dokumentation ausblenden, um einen besseren Überblick über Ihren Quelltext zu bekommen. Öffnen Sie das Kontext-Menü (Rechtsklick), wählen Sie „Ausblenden->Dok-Kommentare“.

 

 

 

 

 

 

Ihr Quelltext wird durch das Ausblenden sofort wieder besser lesbar! Übrig bleibt eine einzelne Zeile „XML-Dokumentation“.

Das Bearbeiten von Dokumentations-Einträgen:

 

Markieren und kopieren Sie die Dokumentation, die sie Bearbeiten möchten. In diesem Beispiel wird die Dokumentation aus Abbildung 6 markiert und kopiert „STRG-V“ oder „STRG-Einfügen“.

Wechseln Sie nun zur SCD Anwendung und klicken Sie auf „importieren“ oder Drücken Sie die F6 Taste. Der Text den Sie in die Zwischenablage kopiert haben, wird nun ausgewertet und in die verschiedenen Bereiche einsortiert. Sie können den Text nun bearbeiten (kopieren anklicken) und wieder in ihre Anwendung einfügen.

 

 

Systemvoraussetzungen

Betriebssysteme

Windows 32 Bit

Ja

Windows 64 Bit

Ja

Systemvoraussetzungen

Arbeitsspeicher

5 MB

Prozessor

Alle gängigen

Bildschirm-Auflösung

800x800