Ocular Coding Style Guidelines

Functions

Usage

Functions should be written when multiple lines of code are used lots of times. However, if the function is a one-line function, it is not necessary.

Comments

You should XML Comment any functions or classes, and it is also recommended that you comment the variables. This is because it allows other developers to see your logic.

What code to write

Make sure everyone is aware of what you are coding, and only commit original code or other code compatible with our license and with permission.

Variables and Properties

Where needed, use properties if external sources require access to a variable, not just a public variable. This way any formatting or restriction (e.g. read only) can be set.

Notice: Feel free to expand this if you feel it is necessary.

Last edited Feb 20, 2013 at 9:05 AM by Aurora01, version 4