Wie muss eine Doku aussehen?

[Martin Schroeder]

Hallo!
Ich bin gerade dabei, mir eine Scriptsprache auszudenken (im Moment einfach zur Übung;mit Interpreter). Und damit ich die vielleich sogar anderen Leuten näher bringen kann, möchte ich gerne wissen, was in eine Doku reingehört und wie die aussehen muss.

 

[BlackLove2005]

Hallo,

wenn es im PHP geht dann wurde mich das auch mal interesieren, wie das aussehen muss. Währe auch froh, wenn mir da jemand mal ein Beispiel geben könnte!

Gruß BlackLove2005

 

[Dennis Wronka]

Ich denke das wichtigste ist eine Liste der Funktionen, mit ihren Parametern und moeglichst auch Beispielen.
Dafuer kann ich PHP.net nur empfehlen.
Weiterhin sollte auch die Syntax an sich erlaeutern werden, also ob z.B. eine neue Zeile die Befehle trennt, oder ein ; oder meinetwegen ob vor jedem Befehl der Ausdruck 'command' stehen muss. Und natuerlich spracheigenene Elemente wie z.B. Schleifen, Abfragen und so weiter.
Wie wird eine Variable deklariert? Wie in PHP mit einem $ am Anfang oder vielleicht willst Du lieber ein # am Anfang nutzen?

Solche Sachen halt.
Am besten wird wohl sein die Sprache zu entwickeln, die Dokumentation zu schreiben und dann ein paar Leute testen lassen.
Am besten sowohl mit als auch ohne Erfahrung in anderen Sprachen.
Dabei solltest Du am besten vor Ort sein um direkt Kommentare entgegen nehmen zu koennen und Hilfe zu leisten.
Die Kommentare und die beanspruchte Hilfe koennen dann wiederum in eine verbesserte Dokumentation einfliessen.

 

[NomadSoul]

Also zur Syntaxbeschreibung würde ich dir zu EBNF raten, was den Rest angeht würde ich auch zu einer Beschreibung ala PHP.net tendieren. Wichtig ist dabei die sinnvolle Untergliederung (Was php.net ned immer gelungen ist.). Du solltest also Arrayfunktionen auch unter dem Themen Punk Arrays halten usw..
Wichtig sind Beispiele und CodeSchnippsel da man daraus am meisten lernt.
NomadSoul

 

[Martin Schroeder]

Was ist EBNF?

 

[NomadSoul]

EBNF ist die Erweiterte Bachus Naur Form. Zitat :"wird zur Beschreibung der Syntax von formalen Sprachen verwendet."
Also kurz erklärt:
Man beschreibt die Syntax von Befehlen nach einem Schema. Dabei wird mit Terminal und NonTerminalsymbolen gearbeitet. Diese werden ensprechend angeordnet und aufgelöst.
am besten schaust du hier:
http://www.cl.uni-heidelberg.de/kurs/ws02/prog2/html/page008.html

oder bei Wikipedia die is aber atm Offline