flat assembler
Message board for the users of flat assembler.

flat assembler > Macroinstructions > Documentation for macros? Please use comments.

Author
Thread Post new topic Reply to topic
evil__donkey



Joined: 07 Dec 2003
Posts: 26
I agree that documenting a program like FASM isn't an easy job, but at least you can make the task easier by including comments that describe macro or procedure behavior. That will enable us to spend time writing code rather than deciphering how a macro works or what parameters should be passed.

For example:

Code:
macro resource dir,[id,lang,label]
    


How much sense does that make? For a beginner to Windows programming, not much actually. Please use some comments to describe every macro that has been written instead of just providing the code.

evil. =)

_________________
--A donkey always says thank you with a kick.
Post 22 Jul 2004, 11:10
View user's profile Send private message Yahoo Messenger MSN Messenger Reply with quote
Tomasz Grysztar
Assembly Artist


Joined: 16 Jun 2003
Posts: 7322
Location: Kraków, Poland
Would detailed documentation of macro purpose and usage (as a block comment before each macro) be enough, or you want also comments for the inner mechanism of macro?
Post 22 Jul 2004, 11:40
View user's profile Send private message Visit poster's website Reply with quote
evil__donkey



Joined: 07 Dec 2003
Posts: 26
Documentation for purpose and usage would suffice for me. =) Thanks Privalov.
Post 22 Jul 2004, 11:45
View user's profile Send private message Yahoo Messenger MSN Messenger Reply with quote
evil__donkey



Joined: 07 Dec 2003
Posts: 26
On second thought, documenting "tricks" you use in the code might prove beneficial too. =)
Post 22 Jul 2004, 12:44
View user's profile Send private message Yahoo Messenger MSN Messenger Reply with quote
silkodyssey



Joined: 02 Oct 2003
Posts: 205
Location: St.Vincent & the Grenadines
I think the macros section of the fasm documentation is incomplete. It's annoying not being able to access the untapped power of the macro system because some features aren't documented.

_________________
silkodyssey
Post 22 Jul 2004, 20:48
View user's profile Send private message MSN Messenger Reply with quote
Tomasz Grysztar
Assembly Artist


Joined: 16 Jun 2003
Posts: 7322
Location: Kraków, Poland
Features are documented. It's the tricky use of the features that is not documented.
Post 22 Jul 2004, 20:55
View user's profile Send private message Visit poster's website Reply with quote
Display posts from previous:
Post new topic Reply to topic

Jump to:  


< Last Thread | Next Thread >
Forum Rules:
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum


Copyright © 1999-2019, Tomasz Grysztar.

Powered by rwasa.