| |
asmDoc - Details (DE)
|
Beispiele |
|
|
|
|
Beispiel 001: Basics
00
01
02
03
04
05
06
07
| ;* Beschreibung der Funktion. Diese Funktion tut rein garnichts
;* @expect:
;* ---
;* @return:
;* EAX, ... = unverändert
doNothing PROC NEAR
ret
ENDP |
- Zeile 00:
Man kann beliebig viel Zeilen untereinander schreiben, wichtig ist hierbei
nur, dass alle Zeilen die zu einer Prozedur gehören mit einem ";*"
beginnen, und bis zur PROC Definition keine Zeile ohne ";*" vorkommt.
Eine Zeile ohne asmDoc Kommentar beendet einen Block.
Eine Zeile mit asmDoc Kommentar startet einen Block.
Für geplante Erweiterungen von asmDoc empfielt es sich, den ersten
Satz prägnant zu formulieren und mit einem Punkt zu terminieren.
- Zeile 01:
In Assembler verwendet man oft Register zur Ansteuerung der angesprungenen
Prozedur. Durch diesen Block leitet man eine Liste von Vorbedinungen
ein, die eine Prozedur erwartet.
- Zeile 02:
Erwartet die Prozedur keine Register so empfielt es sich den Block dennoch
zu erstellen und statt der erwarteteten Register 3 Bindestriche zu schreiben.
- Zeile 03:
Eine Prozedur verändert Register, Speicher usw. Hiermit erzeugt man
eine Liste in der solche Veränderungen stehen.
- Zeile 04:
Es ist oft wichtig zu wissen, dass eine Prozedur wirklich kein Register
verändert.
- Zeile 05:
Der Name der Prozedur oder eines Sprunglabel. In asmDoc werden alle
Prozeduren, egal ob mit asmDoc Kommentar oder ohne, dokumentiert sofern
sie als PROC definiert wurden. Labels werden nur dokumentiert wenn sie
einem asmDoc Kommentar folgen.
- Zeile 06 - 07:
Der Inhalt der Prozedur ist asmDoc bislang egal.
iASys - Tools Division, 06. August 2003
|
|
|
|
|
|
|