coding style - what does @const mean in JavaScript? - Stack Overflow

admin管理员组

文章数量:1201983

We are considering adopting the Google JavaScript coding guidelines within our company to maintain consistency across projects but one thing is confusing me. In the section on constants it says to use the @const keyword annotation for compile-time constant enforcement but I have never come across the @ symbol before. Is this a Google extension or part of the core language?

Here is the full text:

For non-primitives, use the @const annotation.

/**  
* The number of seconds in each of the given units.  
* @type {Object.<number>}  
* @const  
*/
goog.example.SECONDS_TABLE = {  
  minute: 60,
  hour: 60 * 60
  day: 60   * 60 * 24
}

This allows the compiler to enforce constant-ness.

As for the const keyword, Internet Explorer doesn't parse it, so don't use it.

We are considering adopting the Google JavaScript coding guidelines within our company to maintain consistency across projects but one thing is confusing me. In the section on constants it says to use the @const keyword annotation for compile-time constant enforcement but I have never come across the @ symbol before. Is this a Google extension or part of the core language?

Here is the full text:

For non-primitives, use the @const annotation.

/**  
* The number of seconds in each of the given units.  
* @type {Object.<number>}  
* @const  
*/
goog.example.SECONDS_TABLE = {  
  minute: 60,
  hour: 60 * 60
  day: 60   * 60 * 24
}

This allows the compiler to enforce constant-ness.

As for the const keyword, Internet Explorer doesn't parse it, so don't use it.

• javascript
• coding-style

Share Improve this question Follow asked Jun 17, 2011 at 11:21 WheelieWheelie 3,90622 gold badges3535 silver badges3939 bronze badges

Add a comment  | 

2 Answers 2

Sorted by: Reset to default 17

JSDoc annotations as this one can be used to give hints to the Google Closure Compiler as described in this page. Again, this is not part of the language, and the use of @constant (beside adding some information for your fellow programmer) is relevant only if you use the closure compiler in your project.

Hope this will help :)

Looks like it's referring to the use of @const in JSDoc (Think JavaDoc) to mark certain objects constant.

It's not a javascript keyword and not a part of the language – just something used in inline documentation in JSDoc.

Edit: The mention of 'never use the const keyword' may confuse you. The guidelines tell not to use const because IE doesn't support it, instead marking the "constants" constant in the documentation.

Some javascript compiler might parse JSdoc for notation like that, but I doubt it's standard.

本文标签： coding stylewhat does const mean in JavaScriptStack Overflow