- This wiki is out of date, use the continuation of this wiki instead
Standards
From FenixWiki
| Revision as of 12:24, 17 April 2007 (edit) FCR (Talk | contribs) ← Previous diff |
Revision as of 12:25, 17 April 2007 (edit) (undo) FCR (Talk | contribs) Next diff → |
||
| Line 1: | Line 1: | ||
| You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look. | You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look. | ||
| - | == Definition == | + | == Main look == |
| + | === Definition === | ||
| This is the name of the [[function]], [[process]], [[variable]], ... , and also the name of the article. | This is the name of the [[function]], [[process]], [[variable]], ... , and also the name of the article. | ||
| Line 8: | Line 9: | ||
| Below is some general information such as what the function's or variable's purpose, or a specific [[dll]] you need... | Below is some general information such as what the function's or variable's purpose, or a specific [[dll]] you need... | ||
| - | == Returns == | + | === Returns === |
| This is what the function returns; exaplained exactly "what" it returns. for example: a colour, a pixel, an errorcode, etc... | This is what the function returns; exaplained exactly "what" it returns. for example: a colour, a pixel, an errorcode, etc... | ||
| - | == Parameters == | + | === Parameters === |
| These are the [[parameter|parameters]] explained | These are the [[parameter|parameters]] explained | ||
| - | == Example == | + | === Example === |
| A simple example using the function (between <pre> tags). Please do not use links in your code. Refer to the keywords beneath the code in a list. only include relevant keywords. i.e. Do not link to every possible reserved word (as seen in the example code below). | A simple example using the function (between <pre> tags). Please do not use links in your code. Refer to the keywords beneath the code in a list. only include relevant keywords. i.e. Do not link to every possible reserved word (as seen in the example code below). | ||
Revision as of 12:25, 17 April 2007
You do not have to feel obligated, but please try to keep your article according to following standards, so that we can get a homogenic look.
Contents |
Main look
Definition
This is the name of the function, process, variable, ... , and also the name of the article. This block also contains the parameters (the article name doesn't) and return type.
Below is some general information such as what the function's or variable's purpose, or a specific dll you need...
Returns
This is what the function returns; exaplained exactly "what" it returns. for example: a colour, a pixel, an errorcode, etc...
Parameters
These are the parameters explained
Example
A simple example using the function (between <pre> tags). Please do not use links in your code. Refer to the keywords beneath the code in a list. only include relevant keywords. i.e. Do not link to every possible reserved word (as seen in the example code below).
Program test;
Begin
Loop
frame;
End
End
Specific Standards
Here you can find some specific standards (as examples).
