05-20-2005, 08:13 PM
OK, I've looked at this a few different ways (look at the page history) and I have to question the way it is now.
Looking at the ABS keyword as an example http://www.freebasic.net/wiki/wikka.php?wakka=KeyPgAbs.
Vic said to include overload operators and gave an example of syntax that looked like
That is showing how you would declare it as a new function (if there were no ABS function), but I've always taken syntax to mean how you use it. If you look at VB's, QB's, C, etc documentation it gives it similar to the way I have it now.
And then in the descript go on to say that ABS will take any valid numberic expression....etc etc etc (although a note should be add about if you try to take the ABS of U-data type like UBYTE)
I know this isn't VB or QB or anything other than FB, but we can learn from their examples.
The Question then becomes, should we define the syntax to be 'what it is' (a.k.a. Vic's first example) or the 'way it is used' (a la most other languages documentation style)?
Also, is there going to be a 'result' section under the example section, or will the results of the example just be in the example section (as it is now with the ABS). I noticed that a version of the format tut had this.
Looking at the ABS keyword as an example http://www.freebasic.net/wiki/wikka.php?wakka=KeyPgAbs.
Vic said to include overload operators and gave an example of syntax that looked like
Code:
function ABS (byval number as integer) as integerThat is showing how you would declare it as a new function (if there were no ABS function), but I've always taken syntax to mean how you use it. If you look at VB's, QB's, C, etc documentation it gives it similar to the way I have it now.
Code:
ABS ( number )And then in the descript go on to say that ABS will take any valid numberic expression....etc etc etc (although a note should be add about if you try to take the ABS of U-data type like UBYTE)
I know this isn't VB or QB or anything other than FB, but we can learn from their examples.
The Question then becomes, should we define the syntax to be 'what it is' (a.k.a. Vic's first example) or the 'way it is used' (a la most other languages documentation style)?
Also, is there going to be a 'result' section under the example section, or will the results of the example just be in the example section (as it is now with the ABS). I noticed that a version of the format tut had this.