Du bist nicht angemeldet.

DescribeIt - Funktionsheader leicht gemacht (Alpha)

Kontrollzentrum

Spenden

Jeder Euro hilft uns, euch zu helfen.

Oder per Überweisung:
Inhaber: Rene Suhle
Bank: Postbank Stuttgart
BLZ: 60010070
Konto: 439038705
Verwendungszweck: autoit.de
Bitte schickt mir dann ne kurze Nachricht!
NEU:

Downloads

Lieber Besucher, herzlich willkommen bei: .: autoit.de :. - Das deutsche AutoIt-Forum. Falls dies dein erster Besuch auf dieser Seite ist, lies bitte die Hilfe durch. Dort wird dir die Bedienung dieser Seite näher erläutert. Darüber hinaus solltest du dich registrieren, um alle Funktionen dieser Seite nutzen zu können. Benutze das Registrierungsformular, um dich zu registrieren oder informiere dich ausführlich über den Registrierungsvorgang. Falls du dich bereits zu einem früheren Zeitpunkt registriert hast, kannst du dich hier anmelden.

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

1

Sonntag, 28. Februar 2010, 15:32

DescribeIt - Funktionsheader leicht gemacht (Alpha)



Hallo,
Ich möchte euch mein neustes kleines Projekt vorstellen: DescribeIt

Findet ihr es auch mühsehlig für eure UDF Funktionen standardkonforme Funktionsheader "zu Fuß" zu erstellen?
Mit DescribeIt ist damit jetzt Schluss! Die übersichtliche GUI macht es einfach, schnell eine Beschreibung zu erstellen.

Hier mal ein paar Screenshots für den groben Überblick:



Was kann DescribeIt ?
Mit DescribeIt kann man in Windeseile eigene Funktionsheader erstellen, oder bereits vorhandene bearbeiten. Die Header sind standartkonform - wodurch eure UDF direkt noch professioneller wirkt. DescribeIt versucht, bereits vorhandene Header einzulesen und zu verarbeiten. Ist das nicht möglich so wird der Header so weit wie möglich ausgefüllt. (zB standardmäßig On Success/Failure im Return). DescribeIt verändert die Orginaldatei nicht.

Wie verwende ich DescribeIt ?
Zur installation einfach den Installer starten, und den Anweisungen folgen.
Die Anwendung selbst ist denkbar einfach. Zum einlesen eines Scriptes genügt bereits ein Drag & Drop. Alternativ kann eine Datei über den Datei-öffnen Dialog gewählt werden. DescribeIt unterstützt auch das Einlesen von Quellcode aus der Zwischenablage. Im kompilierten Zustand kann auch eine Datei direkt auf die .exe oder eine entsprechende Verknüpfung auf dem Desktop gezogen werden.

Ist der Code eingelesen, wählt man links oben in der ComboBox eine Funktion aus. Diese kann man nun über die einzelenen Bedienelemente der GUI bearbeiten.
Zum speichern reicht es, den entsprechenden Knopf in der GUI zu drücken. Entweder alle Funktionen mit allen erstellten Headern in eine Datei schreiben,
oder den aktuellen bearbeiteten Header in die Zwischenablage kopieren.


Mein Dank an dieser Stelle gilt TimBlo aus dem AutoItBot-Forum, der fleißig eine Projekt Speichern/Laden-Funktion für dieses Tool schreibt geschrieben hat, welche dann aber durch die Import/Export-Funktion ersetzt wurde.
Außerdem danke ich PrideRage für seine Anleitung, wie man das Script in Scite einbaut.

Download ab jetzt extern:
DescribeIt Download
Hier der VirusTotal Bericht:
http://www.virustotal.com/de/analisis/29…138b-1268008513

Sourcecodes sind dabei, falls ihr euch Sorgen machen solltet. Habe die .exen nur zur Angenehmeren Handhabung beigefügt.

ChangeLog zur letzen Version


  • Installer hinzugefügt
  • Diverses Bugfixing & Kleinigkeiten
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

Dieser Beitrag wurde bereits 16 mal editiert, zuletzt von »SEuBo« (8. März 2010, 01:45)

JuraX

User

Registrierungsdatum: 10. Dezember 2009

Wohnort: Bayern

Beruf: Schüler

  • Private Nachricht senden

2

Sonntag, 28. Februar 2010, 15:42

find ich toll :thumbsup:
In einem abgeschlossenen System (=meinen scripten) bleibt die Entropie gleich oder sie nimmt zu!


Meine Website


Meine Projekte:

progandy

AutoItObject-Mitentwickler

Registrierungsdatum: 7. August 2007

  • Private Nachricht senden

3

Sonntag, 28. Februar 2010, 15:45

Sieht super aus, aber da stimmt was noch nicht. Bei deinem Beispiel sind die Paremter nicht richtig. Das sollte so aussehen:

AutoIt-Quellcode

 
1
2
3
4
5
6
7

; Parameters ....: $avArray     - [ByRef] Array to sort
;                  $iDescending - [optional] Ascending or descending (default: 0)
;                  $iStart      - [optional] Index of the first element to sort (default: 0)
;                  $iEnd        - [optional] Index of the element to end with (default: 0)
;                  |(This is the second line 
;                  +and this continues line 2)
;                  $iSubItem    - [optional] Subitem (default: 0)


Außerdem sind mehere Zeilen bei Description nicht erlaubt so weit ich weiß.
"Jetzt, wo ich weiß wie es geht, versteh ich auch die Gebrauchsanleitung"
Antworten auf HILFE-PNs werden nicht garantiert.

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

4

Sonntag, 28. Februar 2010, 15:46

Danke für das Feedback, das werd ich gleich mal korrigieren.
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

progandy

AutoItObject-Mitentwickler

Registrierungsdatum: 7. August 2007

  • Private Nachricht senden

5

Sonntag, 28. Februar 2010, 15:48

Hier gibt es die Infos und ein abgespecktes Programm, das daraus die Textdateien für die Hilfe erstellet. Damit kannst du das Ergebnis testen:
http://www.autoitscript.com/autoit3/udfs…ldTemplates.htm
Dein Skript könnte dann auch noch den Index erstellen und die NODOC-Funktionen markieren ;)
"Jetzt, wo ich weiß wie es geht, versteh ich auch die Gebrauchsanleitung"
Antworten auf HILFE-PNs werden nicht garantiert.

PrideRage

User

Registrierungsdatum: 8. September 2009

Wohnort: Köln

Beruf: Schüler

  • Private Nachricht senden

6

Sonntag, 28. Februar 2010, 15:52

Das Programm ist so geil, ich werd ma versuchen, es in SciTE einzubauen :D
Meine Projekte:
ClipBoard Manager (fertig gestellt)
Gutes ClipBoard Verwaltungs Programm mit nützlichen Funktionen.

HTML Creator
Nützliches Tool um schnell ein eigenes HTML Dokument zu erstellen.

Sprenger120

User

Registrierungsdatum: 25. April 2009

Wohnort: Dras-Leona

Beruf: Schüler

  • Private Nachricht senden

7

Sonntag, 28. Februar 2010, 16:56

Super :thumbsup:
ab in die Toolbox
MfG Sprenger120
Meine Werke Quickdraw Tutorial
Wenn meine Antwort hilfreich war, hinterlass ne Spende.⇙


SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

8

Sonntag, 28. Februar 2010, 18:28

Habe die Parameter jetzt korrigiert und sie sind jetzt hoffentlich standardkonform.

Hinzugekommen ist auch das Importieren der Parameterbeschreibungen (die bis jetzt immer leer gelassen wurden)
Außerdem haben wir die Projekt-Funktionen fast fertig (nur noch ein bisschen bugfixing). Im Prinzip funktionieren sie, aber noch nicht 100%ig, so wie ich das gerne hätte.

Bekannte Bugs, für die ich mir noch was überlegen muss:
- Importfunktion für Parameter liest mehrzeilige Beschreibungen nicht aus.
- Bestimmte Situationen bringen die Projekt - Funktionen zum Absturz-

Neue Version in Post 1

@ProgAndy: nicht dass du denkst, ich hätte dich überlesen: Habe den Parameter-Output entsprechend deinem Link angepasst. Danke jedenfalls dafür, das kann im späteren Projektverlauf (wenn die Kinderkrankheiten beseitigt sind) sehr nützlich werden. Vor allem wenn das Tool so weit ist,
und in SciTE integriert werden kannst, wäre ein "On-The-Fly"-Korrigieren und anpassen des Scriptes natürlich überbombig. Dein Link hilft da sehr gut weiter.

// Edit 2: Und das mit der Nicht-Mehrzeiligen Description wird auch noch gemacht. In der nächsten Version.
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von »SEuBo« (28. Februar 2010, 18:37)

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

9

Montag, 1. März 2010, 18:42

Neue Version:
  1. Das GUI ist angepasst worden, damit es übersichtlicher ist.
  2. Man kann nun die Anzeige zwischen Header-Preview und Orginalfunktion wechseln.
  3. Es ist nun möglich, related functions/links einzutragen.
  4. Auf wunsch können "ungenutzte" Zeilen entfernt werden.
  5. Die Option, interne Funktionen mit einzubeziehen, ist nun standard.
  6. Copy & Paste für Funktionen eingefügt. Dies ermöglicht es, Daten von einer auf die andere Funktion zu übertragen. Übertragen werden Beschreibung, Return Value, Author, Modified, Remarks, Related, Link
  7. Scripte können nun "exportiert" werden. (Zum jetzigen Stand allerdings nur Abwechelnd header und Funktion)
  8. Scripte können nun während dem "normalen" Betrieb eingelesen werden. Man muss also nicht für jedes Include neu starten.
  9. Einiges an Bugfixing.


Download wird in kürze in Post 1 verfügbar sein.
/EDIT: Upload fertig. Bilder eingefügt. Viel spaß damit ;)
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von »SEuBo« (1. März 2010, 18:52)

PrideRage

User

Registrierungsdatum: 8. September 2009

Wohnort: Köln

Beruf: Schüler

  • Private Nachricht senden

10

Montag, 1. März 2010, 20:35

Da kommt jetzt ein Array Error :(
Meine Projekte:
ClipBoard Manager (fertig gestellt)
Gutes ClipBoard Verwaltungs Programm mit nützlichen Funktionen.

HTML Creator
Nützliches Tool um schnell ein eigenes HTML Dokument zu erstellen.

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

11

Montag, 1. März 2010, 21:41

Zitat von »PrideRage«

Da kommt jetzt ein Array Error :(


Könntest du vielleicht ein bisschen genauer werden?
Welcher Error? Was hast du gemacht?

Sag mir was ich tun muss, um den Fehler zu reproduzieren - ich finde nämlich keinen.
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

GerhardSchr

User

Registrierungsdatum: 23. Juni 2009

  • Private Nachricht senden

12

Dienstag, 2. März 2010, 13:31

ich werde mir dieses tolle Thema mal abonnieren :)
danke dafür

Gruß
GerhardSchr

PrideRage

User

Registrierungsdatum: 8. September 2009

Wohnort: Köln

Beruf: Schüler

  • Private Nachricht senden

13

Dienstag, 2. März 2010, 20:31

@SEuBo
Hab ne UDF geladen, dann kam irgendein Error mit nem Array :D
Meine Projekte:
ClipBoard Manager (fertig gestellt)
Gutes ClipBoard Verwaltungs Programm mit nützlichen Funktionen.

HTML Creator
Nützliches Tool um schnell ein eigenes HTML Dokument zu erstellen.

Cartan12

User

Registrierungsdatum: 11. Juni 2009

Beruf: Schüler

  • Private Nachricht senden

14

Dienstag, 2. März 2010, 20:38

Zitat von »PrideRage«

@SEuBo
Hab ne UDF geladen, dann kam irgendein Error mit nem Array :D
Sorry, aber bei solchen Beiträgen bekomm ich echt die Krätze... Wie wärs mit nem Screenshot oder ner Fehlermeldung???
Ich hab die Fehlermeldung jetzt mal selber rausgesucht:

Zitat

C:\Dokumente und Einstellungen\***\Desktop\DescribeIt\DescribeIt.au3 ( 508 ) : ==> Subscript used with non-Array variable.:
$sRet = $aTmp[0][0]
$sRet = $aTmp^ ERROR

  Spoiler Spoiler

Grundkenntnisse in: HTML, XML, C++, Lite-c, JavaScript
Sehr gute Kenntnisse: PHP, JAVA, Joomla, TYPO3 und näturlich AutoIt

Klaviatur, South Park - Downloader, Anhang UDF, GDI+ Mühle
Wer Hilfe braucht:
Skype-->Cartan16

PrideRage

User

Registrierungsdatum: 8. September 2009

Wohnort: Köln

Beruf: Schüler

  • Private Nachricht senden

15

Dienstag, 2. März 2010, 20:44

@Cartan12
Jup, genau dieselbe isses bei mir auch.
Meine Projekte:
ClipBoard Manager (fertig gestellt)
Gutes ClipBoard Verwaltungs Programm mit nützlichen Funktionen.

HTML Creator
Nützliches Tool um schnell ein eigenes HTML Dokument zu erstellen.

Cartan12

User

Registrierungsdatum: 11. Juni 2009

Beruf: Schüler

  • Private Nachricht senden

16

Dienstag, 2. März 2010, 21:01

Ich hab mal nachgeguckt... Die UDF wird nicht richtig ausgelesen, bzw der Array $aInfo wird dadurch falsch dekliniert.

  Spoiler Spoiler

Grundkenntnisse in: HTML, XML, C++, Lite-c, JavaScript
Sehr gute Kenntnisse: PHP, JAVA, Joomla, TYPO3 und näturlich AutoIt

Klaviatur, South Park - Downloader, Anhang UDF, GDI+ Mühle
Wer Hilfe braucht:
Skype-->Cartan16

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

17

Dienstag, 2. März 2010, 21:16

Danke. Diesen Fehler habe ich heute gefunden als ich die "Code per Clipboard einlesen"-Funktion eingebaut habe. In der nächsten Version wird das auch gefixt sein.

Aber der Fehler tritt erst beim öffnen einer UDF auf, wenn schon eine andere offen war, oder?
Beim Scriptstart darf / kann das eigentlich nicht passieren.

Wenn doch postet mal bitte die UDF.
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

Cartan12

User

Registrierungsdatum: 11. Juni 2009

Beruf: Schüler

  • Private Nachricht senden

18

Dienstag, 2. März 2010, 21:21

Jo, das Script stürzt erst nach dem öffnen der UDF ab.
Ich habe eine der offiziellen UDF, die ff.au3 und eine eigene zum testen genommen.

  Spoiler Spoiler

Grundkenntnisse in: HTML, XML, C++, Lite-c, JavaScript
Sehr gute Kenntnisse: PHP, JAVA, Joomla, TYPO3 und näturlich AutoIt

Klaviatur, South Park - Downloader, Anhang UDF, GDI+ Mühle
Wer Hilfe braucht:
Skype-->Cartan16

SEuBo

User

  • »SEuBo« ist der Autor dieses Themas

Registrierungsdatum: 1. März 2009

Wohnort: Unter deinem Bett

Beruf: Spielverderber

  • Private Nachricht senden

19

Mittwoch, 3. März 2010, 12:34

Neue Version

Ich hoffe, dass die nun bei jedem laufen wird.

Changes

  1. RegExp-Pattern zum einlesen von Funktionen korrigiert. Nun werden auch Funktionen OHNE Paramter gefunden.
  2. GUI aufgeräumt. Die TreeView kann jetzt direkt bearbeitet werden (Doppelklick zum umbenennen, Rechtsklick für Kontextmenü)
  3. Source lässt sich nun direkt aus der Zwischenablage einlesen. Im hauptfenster geht man dafür mit einem Rechtsklick auf Open au3 und wählt die entsprechende Option.
  4. Scripte lassen sich nun per Drag & Drop einlesen (thx @PrideRage)
  5. DescribeIt unterstützt nun die Kommandozeile: Einfach eine Datei auf "DescribeIt.exe" ziehen, und diese wird beim Programmstart geladen. (thx @PrideRage)
  6. "Animationen" für Copy, sowie Paste-Icon.
  7. Diverses Bugfixing


Known Bugs


  1. Wenn man direkt auf ein Treeview-Item rechtsklickt, um eien Aktion auszuführen, wird diese nicht angenommen. Das Liegt daran, dass _GUICtrlTreeView_GetSelection() in diesem Fall keinen brauchbaren Return liefert. Ich arbeite dran.

    WorkAround: Zuerst mit linksklick ein Item wählen. Dann mit rechtsklick Aktionen auswählen.



Siehe Post 1



Update: Scheinbar funktinoiert das ganze nur auf meinem Rechner. ich habe mittlerweile den Fehler gefunden (zumindest glaub ich das. Allerdings habe ich es noch nicht geschafft das zu reparieren : Jetzt funktionierts auf dem anderen Rechner, nur auf meinem Notebook nicht mehr. Ich meld mich wenn ich weiter bin.
Calltips automatisch in SciTE eintragen. || DescribeIt - Funktionsheader leicht gemacht

GDI+ Spielereien: Drehende Dreiecke
Meine Tut('s): StringRegExp Tutorial

Dieser Beitrag wurde bereits 2 mal editiert, zuletzt von »SEuBo« (3. März 2010, 23:00)

PrideRage

User

Registrierungsdatum: 8. September 2009

Wohnort: Köln

Beruf: Schüler

  • Private Nachricht senden

20

Mittwoch, 3. März 2010, 20:29

@SEuBo
Nice, aber ich heisse nicht PrideRange, ich heisse PrideRage :D
Bitte Editieren ^^
MfG. PrideRa(n)ge ^^
Meine Projekte:
ClipBoard Manager (fertig gestellt)
Gutes ClipBoard Verwaltungs Programm mit nützlichen Funktionen.

HTML Creator
Nützliches Tool um schnell ein eigenes HTML Dokument zu erstellen.

Ähnliche Themen