Ein Script schreiben, Dokumentation, Teamarbeit Tutorial.

Hilfreiche Erklärungen und Tipps zum Lernen von Autohotkey

Moderator: jNizM

User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Ein Script schreiben, Dokumentation, Teamarbeit Tutorial.

23 Oct 2013, 13:58

Hi ich arbeite seit eine Weile ja an meiner 2D Gameengine.
Im zuge der DAE Idee habe ich vorgeschlagen ein größeres Projekt in der AHK community öffentlich und für jedermann ersichtlich im team fertigzustellen.
Da sich dieses Projekt einigermaßen gut dafür eignet würde ich vorschlagen, dass wir dieses Projekt in der deutschen AHK community fertigstellen.
Ich wollte vorher aber Fragen wer gerne teilnehmen würde.
Also wer hat Zeit langeweile auf der Arbeit eh nichts zu tun (ist Beamter oder ähnliches) und hat Lust teilzunehmen.
Generell gibt es unmengen an Arbeit und verschiedene Arbeitsbereiche, von einfach bis schwer.
Ich wäre dafür das Projekt auf Github zu verwirklichen, habe aber auch nichts gegen eine Forum interne Lösung.
Recommends AHK Studio
Alibaba
Posts: 427
Joined: 29 Sep 2013, 16:15
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

23 Oct 2013, 14:55

Bin dabei.
Wie das ganze erfolgt, ist mir dabei egal... :D
"Nothing is quieter than a loaded gun." - Heinrich Heine
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

23 Oct 2013, 15:03

Dich hatte ich sogar schon eingeplant :D
Recommends AHK Studio
just me
Posts: 5397
Joined: 02 Oct 2013, 08:51
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 01:04

Tut mir leid. Ich halte Gameengines in AHK bisher eher für Machbarkeitsstudien als für erfolgversprechende Projekte. Außerdem ist das nicht mein Metier. Ich werde mir das aber anschauen und mich melden, falls ich etwas beitragen kann.
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 05:23

Dokumentation:
Wir müssen uns standardmäßig auf eine Dokumentationsweise einigen.
Ich bevorzuge diese Methode selbst wenn es länger dauert:

Code: [Select all] [Expand] [Download] (Memmngmnt.ahk)GeSHi © Codebox Plus

Recommends AHK Studio
User avatar
jNizM
Posts: 2317
Joined: 30 Sep 2013, 01:33
GitHub: jNizM
Contact:

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 06:14

Schau dir mal die UDF-Aufbauweise von AutoIt an

hier noch ein Beispiel aus den Includes _ColorSetRGB
[AHK] 1.1.28.02 x64 Unicode | [WIN] 10 Pro (Version 1803) x64 | [GitHub] Profile
Donations are appreciated if I could help you
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 06:57

Heißt das jetzt du machst mit?
Recommends AHK Studio
User avatar
hoppfrosch
Posts: 317
Joined: 07 Oct 2013, 04:05
GitHub: hoppfrosch
Location: Rhine-Maine-Area, Hesse, Germany
Contact:

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 07:21

Ich bin nicht dabei (too much things to do - too less time) :) , möchte aber trotzdem kurz meinen Senf zu nnik's Doku-Vorschlag geben:

Überlegt zu welchem Zweck die Dokumentation dienen soll - in der Regel sind zwei Hauptzwecke damit verbunden:
* "Benutzerdokumentation" - dort wird in der Regel dokumentiert, was jemand wissen muss, der die Funktion nutzen will (z.Bsp Zweck der Funktion, Ein-/Rückgabeparameter)
* "Entwicklerdokumentation" - Beschreibung von (nicht trivialen) Implementierungsdetails (z.B. "Was passiert in dieser komplizierten FOR-Schleife?")

Ich versuche bei mir beide getrennt zu halten: im Funktionsheader habe ich in der Regel die "Benutzerdokumentation" (Beschreibung des Interface) in einer Form, in der ich mit Tools einfach eine externe (z.B HTML-) Dokumentation ableiten kann (Tools: doxygen, NaturalDocs oder GenDocs ...). Die Benutzerdokumentation sollte für alle Entwickler standardisiert sein. Die Entwicklerdokumentation erfolgt hingegen mit Standardkommentaren im Code direkt ... (mit evtl persönlicher Handschrift des Entwicklers)

Bei nniks Bsp sind beide Typen etwas vermischt:

Code: [Select all] [Expand] [Download] (Script.ahk)GeSHi © Codebox Plus



Was interessiert einen möglichen Benutzer der Funktion HeapFree welche Funktionen intern aufgerufen werden? Das gehört für mich eigentlich in die Entwicklerdoku ...
Last edited by hoppfrosch on 24 Oct 2013, 07:25, edited 1 time in total.
User avatar
jNizM
Posts: 2317
Joined: 30 Sep 2013, 01:33
GitHub: jNizM
Contact:

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 07:23

Ich bin zzt mit Dll's beschäftigt :D
Das war nur ein Hinweis, wie man das ganze einheitlich (mit Struktur) aufbauen kann.
[AHK] 1.1.28.02 x64 Unicode | [WIN] 10 Pro (Version 1803) x64 | [GitHub] Profile
Donations are appreciated if I could help you
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

24 Oct 2013, 10:39

Nun ja das sind ja auch nicht Benutzerdokumentationen.
In diesem Fall sind es nur interne Funktionen.
Das Benutzer Interface ist viel einfacher.
Recommends AHK Studio
Alibaba
Posts: 427
Joined: 29 Sep 2013, 16:15
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

25 Oct 2013, 05:39

Ich persönlich würde eine strikte Dokumentation nur für die Endnutzerfunktionen des Interfaces vorschlagen. Diese sollten dann die AutoIt UDF Dokumentationsweise, welche von jNizM vorgeschlagen wurde, als Vorbild haben, also in etwa so:

Code: [Select all] [Expand] [Download] GeSHi © Codebox Plus



Die Dokumentationen für interne Funktionen, welche nur für Entwickler dienlich sind, können meiner Meinung nach ruhig die "Handschrift" des jeweiligen Erstellers tragen, sollten allerdings in jedem fall vorhanden sein.
"Nothing is quieter than a loaded gun." - Heinrich Heine
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

25 Oct 2013, 09:16

Für die Endnutzerfunktionen werde ich mehr als eine einfache Dokumentation schreiben ich dachte da an eine Hilfedatei + Tutorial.
Recommends AHK Studio
Alibaba
Posts: 427
Joined: 29 Sep 2013, 16:15
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

25 Oct 2013, 10:14

nnnik wrote:Für die Endnutzerfunktionen werde ich mehr als eine einfache Dokumentation schreiben ich dachte da an eine Hilfedatei + Tutorial.


Naja, das wäre ja noch besser. :D
Heißt das jetzt, dass sich deine eigentliche Forderung nach einer einheitlichen Dokumentation nur auf die internen Funktionen bezieht?
"Nothing is quieter than a loaded gun." - Heinrich Heine
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

25 Oct 2013, 10:43

Ja das ist Teil der Teamarbeit.
Zudem soll ja jeder einigermaßen auch den Code verstehen.
Recommends AHK Studio
Alibaba
Posts: 427
Joined: 29 Sep 2013, 16:15
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

25 Oct 2013, 16:43

Ok.
In dem Fall wäre meiner Meinung nach eine Verbindung aus der von dir vorgeschlagenen Methode (zur generellen Beschreibung der Funktion) und den inline-Kommentaren (zur Erklärung interner Strukturen) am besten.
"Nothing is quieter than a loaded gun." - Heinrich Heine
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

03 Nov 2013, 08:11

Also wir brauchen noch jemanden sonst lohnt sich ein Teamwork projekt eig. nicht.
Recommends AHK Studio
Alibaba
Posts: 427
Joined: 29 Sep 2013, 16:15
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

03 Nov 2013, 08:13

Ich hätte auch nichts dagegen, wenn wir mit Leuten aus der englischen Community zusammenarbeiten.
Dann müssen wir die Doku halt auf Englisch anlegen...
"Nothing is quieter than a loaded gun." - Heinrich Heine
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

03 Nov 2013, 08:19

Jo OK hört sich nicht schlecht an.
Recommends AHK Studio
Bentschi
Posts: 18
Joined: 02 Oct 2013, 18:45

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

04 Nov 2013, 09:15

Erst war ich unsicher, da ich kein Beamter bin, aber wäre doch gerne dabei.
Natürlich nur für Hirnschmalzvorderndes, aber leider auch nur ab und zu mal eben ein paar 100 Zeilen oder so (enger Zeitplan).
User avatar
nnnik
Posts: 2905
Joined: 30 Sep 2013, 01:01
Location: Germany

Re: Ein Script schreiben, Dokumentation, Teamarbeit Tutorial

04 Nov 2013, 09:36

das ist natürlich super gut weil du dich garantiert mit OpenAL auskennst, oder?
Recommends AHK Studio

Return to “Tutorials”

Who is online

Users browsing this forum: No registered users and 1 guest