代码之家  ›  专栏  ›  技术社区  ›  Phiter

按参数返回对象属性的文档函数

  •  1
  • Phiter  · 技术社区  · 6 年前

    我正在为我的Vue.js应用程序创建一个Api存储库,如下所示 this article .

    问题是,我喜欢记录我的函数,以便在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函数是repositories对象的一个简单的acessor。

    我试着用 @typedef @type ,但没有一个工作正常。

    我试过类似的 @returns {repositories.name} ,但也不起作用。

    有办法记录下来吗?

    我也想过使用一个类型脚本定义文件,但是我从来没有这样做过,所以我不知道从哪里开始。

    0 回复  |  直到 6 年前