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。