我如何用jsdoc发表这个评论

时间:2012-01-06 19:44:40

标签: javascript jsdoc code-documentation

如何使用jsdoc正确地发表评论。任何想法???

   /**********************
* @variables : global variables
***************************/
var map; // this var handle the object related with the map
var image;
var currentMark;

1 个答案:

答案 0 :(得分:1)

只需在变量前添加文档注释:

/** this var handle the object related with the map */
var map;
/** An image */
var image;
// Undocumented variables will not show up
var currentMark;