javascript - 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,'*/');
        }
    }
};

请注意，我还没有尝试过这个，但它应该可以解决问题。