Coding standards
From OpenSimulator
(Difference between revisions)
| Line 12: | Line 12: | ||
ASSET_TYPE_TO_EXTENSION[(sbyte)AssetType.Script] = "_script.txt"; // Not sure if we'll ever see this | ASSET_TYPE_TO_EXTENSION[(sbyte)AssetType.Script] = "_script.txt"; // Not sure if we'll ever see this | ||
#pragma warning restore 0612 | #pragma warning restore 0612 | ||
| + | |||
| + | Otherwise in general, just respect the conventions already being used in the file you're editing (which should often follow the [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx standard C# coding guidelines]). | ||
==Example== | ==Example== | ||
| Line 22: | Line 24: | ||
} | } | ||
} | } | ||
| − | |||
| − | |||
Revision as of 12:23, 12 July 2008
Guidelines
Generally speaking
- We put curly brackets on separate lines and use 4 space tabs.
- Tab themselves should be spaces, not actual hard tabs.
- Method names have all their words capitalized (as opposed to Java, which culturally uses camelCase).
- Unless the classes are very trivial, there should be one class per file.
- Please keep the code warning free, using #pragma only if absolutely necessary. For instance
#pragma warning disable 0612
ASSET_TYPE_TO_EXTENSION[(sbyte)AssetType.Script] = "_script.txt"; // Not sure if we'll ever see this
#pragma warning restore 0612
Otherwise in general, just respect the conventions already being used in the file you're editing (which should often follow the standard C# coding guidelines).
Example
public void WakeUp()
{
if (tooTired)
{
Thread.Sleep(3600);
}
}
