jsdoc如何打破/关闭标签

时间:2016-06-26 16:59:23

标签: tags jsdoc3

我想在两个示例之间插入描述

/**
*@method ChangeItem
*@example
*oMenu.ChangeItem("menu.enable_all",{enable:true});
*oMenu.ChangeItem("menu",label:"",icon:align:"after",text:ICO.arrow_down}});
*
*If I write description here, it appear into the first example
*
*@example  
*oMenu.ChangeItem("menu.enable_all",{enable:true});
*oMenu.ChangeItem("menu",{label:"",icon:{align:"after",text:ICO.arrow_down}});
*/

如何关闭第一个标签?

我尝试使用标记描述,但它在第一个示例的顶部 对不起我的英语和愚蠢的问题

1 个答案:

答案 0 :(得分:0)

我不认为可以这样做,我没有尝试,但您可以将@description放在您的描述前(但这可能不会将您的描述放在正确的位置)。< / p>

我认为更简洁的方法是在您放置代码注释(例如

)时有一个@example
oMenu.ChangeItem("menu.enable_all",{enable:true});
oMenu.ChangeItem("menu",label:"",icon:align:"after",text:ICO.arrow_down}});

// Example 2
oMenu.ChangeItem("menu.enable_all",{enable:true});
oMenu.ChangeItem("menu",{label:"",icon:{align:"after",text:ICO.arrow_down}});