- This wiki is out of date, use the continuation of this wiki instead
Standards:function
From FenixWiki
Click here to get the template.
NOTE: In the WikiCode, before a new section there is one empty line and after there is one or none. Categories can either be at the top or the bottom in the WikiCode. Add a function to the category "functions" and to any other it applies (like "networkdllfunctions").
Contents |
Definition
INT Example_function ( <INT example_int> , <WORD example_word> , [<STRING example_string>] )
Does something.
Here goes a more detailed story about the function.
NOTE: "Does something" is a small summary of the function, in one sentence. Then a white line and then a more indepth story about the function. The "[]" indicate an optional parameter.
Parameters
INT example_int | - Something about this int. |
WORD example_word | - Something about this word. |
[STRING example_string] | - Something about this string. |
NOTE: Use a list, it will result in a much better look. The "-" could be left out, but actually looks nice.
Returns
INT : Some int.
NOTE: If it returns a code, like an errorcode, you can make a list: {| | some errorcode || - blabla |- | another || - yadayada |}
Notes
Here are some notes, which explains some parts in more depth. Mostly not needed, in which case it can be left out.
Example
Program example; Begin Loop frame; End End
NOTE: Please keep "tabs" at 4 spaces. Try to make the code look tidy and readable.