jsdoc-to-markdown生成注释，读取注释内容为空

Question

生成文档脚本如下，但是读取到的注释内容x为空，怎么回事呢

const fs = require('fs-extra');
const path = require('path');
const jsdoc2md = require('jsdoc-to-markdown');

jsdoc2md
  .render({
    'example-lang': 'javascript',
    files: path.resolve(process.cwd(), './src/rpc/beanServiceRpc.js'),
    'name-format': 'backticks',
    //template: fs.readFileSync('./scripts/api.handlebars', 'utf8'),
  })
  .then(x => {
    console.log("x----->", x);
    fs.outputFile(path.resolve(process.cwd(), './docs/README.md'), x);
  });
  
  

beanServiceRpc.js文件内容如下：

import {URL_SHARE_GET_BEANS, URL_GET_JING_BEANS} from '../constants/apiUrl';
import httpService from '../common/services/httpService';
export default {
  /**
   * 分享领取
   * @param to
   * @param from
   * @return {AxiosPromise<any>}
   */
  shareGetBeans: function (to, from) {
    
  },
  /**
   * 获取信息
   * @param skuId
   * @param price
   * @param skuType
   * @return {AxiosPromise<any>}
   */
  getJingBeanNum: function (skuId, price, skuType) {
   
  }
};

但是如果文件内容是以下内容就可以读取到注释内容

/**
* @description 加法运算
* @param {Num} num1 加数
* @param {Num} num2 被加数
* @return {Num} result 结果
*/
function add(num1,num2){
    return num1 + num2;
}

/**
* @description 减法运算
* @param {Num} num1 减数
* @param {Num} num2 被减数
* @return {Num} result 结果
*/
function minus(num1,num2){
    return num1 – num2;
}

Answer 1

jsdoc对对象的方法解析不支持没如果你想要得到注释，可以修改成class，导出的时候new一下