通过参数返回对象属性的文档功能

时间:2018-12-31 01:40:46

标签: javascript jsdoc

this article之后,我正在为Vue.js应用程序创建Api存储库。

问题是,我想记录我的函数,以便在VSCode上获得更好的代码完成率。我通常为此使用jsDoc。

我被困在这里:

import DiarioEscolarRepository from './diarioEscolarRepository';
import PeriodoAvaliativoRepository from './periodoAvaliativoRepository';
import AtividadeAvaliativaRepository from './atividadeAvaliativaRepository';
import CorteEtarioRepository from './corteEtarioRepository';

const repositories = {
  diarioEscolar: DiarioEscolarRepository,
  periodoAvaliativo: PeriodoAvaliativoRepository,
  atividadeAvaliativa: AtividadeAvaliativaRepository,
  corteEtario: CorteEtarioRepository,
};

export default const RepositoryFactory = {
  get(name){
    return repositories[name];
  }
};

我需要这样做,以便编辑器理解get函数是存储库对象的简单继承人。

我尝试使用@typedef@type,但是它们都无法正常工作。

我尝试了类似@returns {repositories.name}的操作,但也没有用。

有没有办法对此进行记录?

我还考虑过使用打字稿定义文件,但是我从未使用过,所以我不知道从哪里开始。

0 个答案:

没有答案