- This wiki is out of date, use the continuation of this wiki instead
Standards
From FenixWiki
Revision as of 12:25, 17 April 2007 (edit) FCR (Talk | contribs) ← Previous diff |
Revision as of 13:28, 17 April 2007 (edit) (undo) Sandman (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. The standards are quite natural and will appear logical when followed. |
- | Also look at these | + | Also look at these: |
- | * [[ | + | * [[Standards function]] |
+ | * [[Standards variable]] | ||
Line 9: | Line 10: | ||
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. | ||
- | 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... | Below is some general information such as what the function's or variable's purpose, or a specific [[dll]] you need... | ||
- | == Returns == | ||
- | + | == Notes == | |
- | + | Some more in depth information about the subject, if needed. | |
- | 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 | + | A simple example using the function (between <pre> tags). Please do not use links in your code, but refer to the keywords beneath the code in a list, if needed. Only include relevant keywords, i.e. do not link to every possible reserved word. The example doesn't have to be advanced or big, on the contrary, simple examples are better. |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + |
Revision as of 13:28, 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. The standards are quite natural and will appear logical when followed.
Also look at these:
Definition
This is the name of the function, process, variable, ... , and also the name of the article.
Below is some general information such as what the function's or variable's purpose, or a specific dll you need...
Notes
Some more in depth information about the subject, if needed.
Example
A simple example using the function (between <pre> tags). Please do not use links in your code, but refer to the keywords beneath the code in a list, if needed. Only include relevant keywords, i.e. do not link to every possible reserved word. The example doesn't have to be advanced or big, on the contrary, simple examples are better.