/wiki/TagConstant.wiki

http://jsdoc-toolkit.googlecode.com/ · Unknown · 20 lines · 14 code · 6 blank · 0 comment · 0 complexity · a9c0876996638701e2f10b1bcfa60198 MD5 · raw file 

    

  1. #summary @constant
    2. 

  2. 

  3. == The @constant Tag ==
    4. 

  4. 

  5. The `@constant` tag allows you to mark a variable as being constant.
    6. 

  6. 

  7. === Syntax ===
    8. 

  8. 

  9. {{{
    10. 

  10. @constant
    11. 

  11. }}}
    12. 

  12. 

  13. === Example ===
    14. 

  14. 

  15. {{{
    16. 

  16. /**
    17. 

  17.  * @constant
    18. 

  18.  */
    19. 

  19. const acceleration = 9.80665;
    20. 

  20. }}}
    21.