JSDoc評論中的JSDoc評論

Question

我在給JSDoc注釋的代碼示例也包含JSDoc注釋，如何在不破壞外部注釋的情況下轉義嵌套的JSDoc注釋？

我使用的是版本3.3.0-beta3

例：

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

嵌套的*/ will當然會破壞評論。 額外的空間會阻止這個* /或a *\\/ ，然后 - 當然 - 出現在JSDoc文檔中，我不想要。

有沒有辦法逃避這個，所以生成的JSDoc看起來像正確的代碼？

Answer 1

我不知道如何逃避這個，但你可以編寫一個簡單的插件

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

請注意，我沒有嘗試過，但應該這樣做。

Answer 2

如果您願意在Markdown代碼塊而不是JSDoc @example塊中使用示例，則可以按照此處所述啟用Markdown插件，並使用HTML字符引用來轉義一個或多個有問題的嵌套注釋字符，如下所示：

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

已經過測試，可以使用JSDoc 3.3.2。