Is it standard practice to use all caps for a JavaScript Namespace?

Question

I have been using namespaces to package my JavaScript code. In some of the examples that I have read, all caps have been used for the global name. For example: MYAPPLICATIONNAME.module.function

Is using all capitals the best practice since it seperates the vars in the global namespace, or is it just more confusing?

score 7 · Accepted Answer · answered Nov 22 '10 at 16:57

7

I think it is a good practice to use all caps to represent global variables, see: http://javascript.crockford.com/code.html

YUI is one of the example, e.g. YAHOO or YUI

answered Nov 22 '10 at 16:57

tszming

2,084
12
15

1

Interesting, I didn't realize that was in his code conventions – rsideb Nov 22 '10 at 17:00

score 1 · Answer 2 · edited May 23 '17 at 10:30

1

No, I don't believe so (quick tutorial). I would find it more confusing, personally. lowerCamelCase or UpperCamelCase is standard Java/Javascript convention.

Caps are usually used for constants. For example,

var MAX_LENGTH = 5;

Edit: Now that I look back at that link again, I see that the author did in fact use all caps in his namespace. But some do not. Again, I personally find it confusing and would only consider doing it if I was creating an immutable singleton. But even then, there are probably better ways.

edited May 23 '17 at 10:30

Community

1
1

answered Nov 22 '10 at 16:53

Courtney Christensen

9,165
5
47
56

1

This was my initial thought, but the book I have been reading gave the recommendation of ALL CAPS. – rsideb Nov 22 '10 at 16:57
Interesting. What book is it, out of curiosity? EDIT: I guess I can see the logic if you are making a singleton with said namespace. – Courtney Christensen Nov 22 '10 at 16:59
JavaScript Patterns By: Stoyan Stefanov – rsideb Nov 22 '10 at 17:01

score 1 · Answer 3 · answered Nov 22 '10 at 17:32

The most important thing about standard practices is that you pick one and stick to it. In some cases, the standard practice is, well, fairly standard. Such as using all caps for constants in languages that support them. I have never encountered a namespacing standard practice for JavaScript.

I would suggest picking one that makes the most sense to you, and sticking with it. Maybe take a look at one of your favorite JS libraries, see what they do.

score 0 · Answer 4 · answered Nov 22 '10 at 16:50

0

Nope that would be a preference. Personally I use camelCase.

answered Nov 22 '10 at 16:50

John Hartsock

85,422
23
131
146

score 0 · Answer 5 · answered Nov 22 '10 at 16:53

0

I've used ALL CAP variable for constants, but not namespacing.

My experience is Java-style code formatting.

answered Nov 22 '10 at 16:53

John Giotta

16,432
7
52
82

Is it standard practice to use all caps for a JavaScript Namespace?

5 Answers5