JSDoc注释中的JSDoc注释

Question

我给出了带有JSDoc注释的代码示例，这些注释也包含JSDoc注释，如何在不破坏外部注释的情况下转义嵌套的JSDoc注释？

我使用的是版本3.3.0-beta3

示例：

 /**
  * @example
  * /**
  *  * Description.
  *  * @alias ...
  *  * @extends ...
  *  * @constructor
  *  */
  * function Something() {
  *     ...
  * }
  * ...
  */
 function MyFun() {
 ...

嵌套的*/当然会破坏注释。额外的空间将阻止这个* /或*\/，然后-当然-显示在JSDoc文档中，这是我不想要的。

有没有办法避免这种情况，这样生成的JSDoc看起来就像正确的代码？

Answer 1

我不知道有什么方法可以避免这种情况，但是你可以写一个简单的插件

exports.handlers = {
    newDoclet : function(doclet) {
        if(doclet.example){
            doclet.example = doclet.example.replace(/*\//g,'*/');
        }
    }
};

请注意，我还没有尝试过这一点，但它应该可以做到这一点。

Answer 2

如果您愿意在Markdown代码块中使用示例，而不是使用JSDoc @example块，您可以按照here的说明启用Markdown插件，并使用HTML character references来转义一个或多个有问题的嵌套注释字符，如下所示：

/**
 * Example:
 *
 *     /**
 *      * Description.
 *      * @alias ...
 *      * @extends ...
 *      * @constructor
 *      */
 *     function Something() {
 *         ...
 *     }
 *     ...
 */
function MyFun() {
...

这已经在JSDoc 3.3.2上测试过了。