как документировать это ключевое слово в пользовательских компонентах с помощью jsDo c?

Question

Я использую Vuejs встроенные компоненты шаблона, где мы регистрируем компонент в файле javascript, а шаблон в html.

компонент выглядит примерно так:

Vue.component('compare-benefits', {
  data() {
     // the "this" keyword in methods should refer to this object
     return {
        ...state,
        isLoading: false,
     }
  },
  methods: {
    getData() {
       // I want the "this" keyword here to reference the object return in data above 
       this.isLoading = true;
    }
  }
})

Если вы не знакомы с Vue, то здесь происходит то, что Vue framework привяжет ключевое слово this в ваших методах к объекту, который вы возвращаете из метода data ().

Как мне использовать здесь jsDo c и сообщить ему, что ключевое слово this на самом деле ссылается на этот объект?

EDIT : Основная причина использования jsDo c - не для создания документации, а для использования intellisense и проверки типов в vscode с использованием @ts-check

Answer 1

Ключевое слово this в Vue framework - это объект типа Vue. Вы можете идентифицировать это, отладив свой код в своем методе getData или любым другим методом. Более того, Vue data - это свойства this. Я загрузил снимок экрана ниже, чтобы вы могли увидеть его из моего собственного примера, над которым я сейчас работаю:

введите описание изображения здесь

В результате ваш код после использования jsDo c будет таким:

Vue.component('compare-benefits', {
    data() {
        return {
            ...state,
            isLoading: false,
        }
    },
    methods: {
        /** @this Vue */
        getData() {
            this.isLoading = true;
        }
    }
})

Answer 2

Не знаю Vue. js. Однако мои знания JSDo c могут вам помочь. Ключевое слово this может быть задокументировано следующим образом:

/**
 * @this Vue
 */

Здесь 'Vue' должно быть объявлено в JSDo c. Вы можете найти его в Vue. js документах. Вы можете заглянуть в этот файл , чтобы найти примеры создания классов, перечислений, функций и т. Д. c. и их использование в JSDo c.