-
Notifications
You must be signed in to change notification settings - Fork 6
Naming Conventions
jbracker edited this page Mar 12, 2013
·
4 revisions
Whan writing function in Sunroof the following naming conventions should comply:
-
No Prefix/Suffix: General combinators and API methods that return a
JS t a
do not get a suffix or prefix.Examples:
apply
,function
,new
; -
Suffix
JS
: Everything that takes aJS t a
as argument has the suffixJS
.Examples:
forkJS
,sunroofCompileJS
; -
Prefix
JS
: Types that directly represent Javascript values (generaly all that implement Sunroof) should haveJS
as prefix.Examples:
JSBool
,JSString
,JSDate
; -
Prefix
Sunroof
: Classes that are tightly connected with Sunroof should have the prefixSunroof
.Examples:
SunroofArgument
,SunroofThread
;