Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Sonstige Werkzeuge (https://www.delphipraxis.net/63-sonstige-werkzeuge/)
-   -   * chm files -> Programm, Hilfe (https://www.delphipraxis.net/171200-%2A-chm-files-programm-hilfe.html)

bernhard_LA 25. Okt 2012 13:14

* chm files -> Programm, Hilfe
 
das Tool Documentation Inside ( http://www.devjetsoftware.com/produc...ion-insight/ )bietet in der Vollversion die Möglichkeit meine Source Code Komementare in einer (*.chm) Hilfe-Datei abzuspeichern.

Für das Software- Entwickler Team eine große Unterstützung beim Aufbau eines gemeinsamen Verständnisses der vorliegenden source codes.

Gibt es eine Möglichkeit die Source Code Kommentare für GUI Funktionen automatisch zu einer Hilfedatei für mein Programm zu erstellen

Dh. ich tippe in die Source code Docu zu einem Button Pressed Event ein "hier macht das programm folgendes " , ein Tool ??? macht dann einen zusätzlichen HELP Button neben meinen BUtton und zeigt dem Benutzer meiner Software diesen Hilfe Text an.


was hätte ich gerne :
* Hilfetext und Source Code Kommentare stehen in der selben Datei nebeneinander
* ich muss nicht iregendwelche Links auf die Hilfedatei pflegen
* ich muss mich nicht um die Anzeige der Hilfedatei aus meiner Anwendung heraus kümmern


wünsche ich mir hier zuviel ?

blondervolker 25. Okt 2012 15:27

AW: * chm files -> Programm, Hilfe
 
Liste der Anhänge anzeigen (Anzahl: 2)
Hallo,

ich hab mal ein Beispiel drangehangen.ich arbeite mit Fasthelp.
Da sehe ich genau was los ist und welchen Topic und Tralala...
ich gleich reinklatschen kann.:-D

Vielleicht hilft's...:thumb:

bernhard_LA 25. Okt 2012 22:05

AW: * chm files -> Programm, Hilfe
 
danke , ich hatte an einer Erweiterung der aktuellen XML Source code doku in Delphi XE und höher

Delphi-Quellcode:
   {$REGION 'Documentation'}
    ///   <summary>
    ///     TCP server main execute procedure
    ///   </summary>
    ///   <param name="AContext">
    ///     a tcp server thread
    ///   </param>
    ///   <exception cref="">
    ///   </exception>
    ///   <remarks>
    ///     need to be syncronized with the vcl threads
    ///   </remarks>
    ///   <example>
    ///     not used
    ///   </example>
    ///   <seealso cref="see" />
    {$ENDREGION}
    procedure IdTCPServerExecute(AContext: TIdContext);

gedacht; sowas wie

/// <Help>
/// wie du hier was machst passiert ..... bla bla
///</Help>


und dieses wird danngleich der HilfeFile für meinen Programmbenutzer


Alle Zeitangaben in WEZ +1. Es ist jetzt 05:17 Uhr.

Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz