我怎样才能用 jsdoc 发表评论

Question

我怎样才能使用 jsdoc 正确地发表此评论。有什么想法？？？

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

Answer 1

只需在变量前添加一个文档注释：

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