Naming Conventions¶

Purpose¶

The Rapise engine and API follow some simple naming conventions.

Usage¶

You will find descriptions of the naming conventions below. Note: italicized text represents placeholders.

SeS*<...>* - public functions for user
Do*<Action>* - action implementations
_<somevar> and _<somename> - private functions and objects
g_<varname> - system global variable.

Private Variables and Functions in the Object Tree¶

Any custom function or variable that you define in User.js, Common.js, or any other .js file will be displayed in the corresponding node of the object tree.

However, there are two exceptions that can help you hide internal functions or variables from the tree:

If you prefix a function name with an underscore, such as _myFunc, those functions will be automatically filtered and not displayed in the tree.
You can use /** @private */ and /** @ignore */ comments to indicate that a function or variable should be treated as private or ignored, respectively.

Public and Private

Examples¶

Here are some examples to clarify the above conventions:

SeS("object") // gets the object named "object"
DoClick()     // public action function to click on something
_mydata       // private variable called mydata
g_publicdata  // global variable called publicdata