Coding Conventions for Solution Sites
Variables and file names in the code for the Solution Sites are named using common conventions. All variables in the code for the Solution Sites can be identified by their prefix. The prefixes used in naming local variables, framework variables, dictionary variables, and file names are defined in the following tables.
Local Variables
Framework Variables
Dictionary Variables
File Name Prefixes
Local Variables
The following table lists the base types used in naming local variables in the code for the Solution Sites.
| Prefix | Description |
|---|---|
| arr | Signifies an array |
| b | Signifies a boolean |
| f | Signifies a flag |
| htm | Signifies an HTML string |
| i | Signifies an integer |
| list | Signifies a SimpleList |
| o | Signifies an object |
| s | Signifies a non-HTML string |
Framework Variables
The following table lists the prefixes used to name framework variables in the code for the Solution Sites.
| Prefix | Description |
|---|---|
| MSCS | Initialized with values from application scope variables. |
| mscs | Signifies that the variable holds page-scope objects. |
| m_ | Signifies that the variable holds private page-scope values. |
Dictionary Variables
The following table lists the prefix used to name dictionary variables in the Solution Sites code.
| Prefix | Description |
|---|---|
| dict | Signifies the variable is a dictionary variable. |
File Name Prefixes
The following table lists the prefix used to name files in the Solution Sites code.
| Prefix | Description |
|---|---|
| _ | Signifies that there is no user interface for the file. This convention only applies to files in the <site name> folder, and not to files in the <site name> subdirectories. |
Copyright © 2005 Microsoft Corporation.
All rights reserved.