-
Notifications
You must be signed in to change notification settings - Fork 1
Style Guide
Proposed style guide in development
Components should be in title case and resemble Classes.
Crafty.c("MyComponent", {
Methods should use camel case.
.myMethod()
Properties should again be camel case.
.myProperty
Private members must have an underscore _ before the name. Only make it private if the user/developer should never invoke it or modify it. Public members can be anything as long as there is no underscore at the beginning.
If the property is to be modified through Crafty Builder, it should be public.
Events should describe the action taking place. The event name should be in title case.
this.trigger("ButtonClicked")
Multiline comments should be at the start of every component detailing the purpose and the start of every public method and property. The multiline comments will be generated into the API. Use Markdown syntax to describe the method, property or component. It should start with /**@ to denote that this should be generated.
Use the following template for documenting:
/**@
* #Crafty.pause
* @comp Parent Component else @category Relevant Category
* Unbinds all enterframe handlers and stores them away.
* Calling `.pause()` again will restore previously deactivated handlers.
*
* @sign public this Crafty.pause()
* @sign public this Crafty.pause(String id);
* @param name - Description of parameter
* @param another - Description
* @example
* Explanation about what the example is doing.
* ~~~
* [code here]
* ~~~
*/
See here for Markdown syntax. @sign is used for the method signature. Include the visibility, the return value, the method and the parameters. If there is more than one way to use the method, include another @sign. Use square brackets in the parameter list for optional parameters.
@sign public this Crafty.pause([Number id])
The three tildas ~ denote a block of code. Put three one line before the code block and one after. It must be three.
Use single line comments whenever necessary.
Try not pollute the Crafty. namespace too much. Use closures to create private variables for things that shouldn't be used or modified. Everything under the Crafty namespace should be documented and useful to the user.