2016-09-19 9 views
0

В JSDoc @param,JSDoc тип данных в @param

We can write like: 
    /** 
    * @param {Object} somebody- The employee who is responsible. 
    */ 
    function sayHello(somebody: ABC) { 
     alert('Hello ' + somebody); 
    } 

Если у меня есть класс, как ABC и кто-то является объектом типа ABC, я могу написать это ,?

/** 
    * @param {ABC} somebody- The employee who is responsible. 
    */ 
    function sayHello(somebody: ABC) { 
     alert('Hello ' + somebody); 
    } 

То есть, могу ли я указать свой собственный тип объекта внутри фигурных скобок param, а не давать как объект? Спасибо заранее ...

ответ

1

Рассматривая свой код, вы, вероятно, используете TypeScript. У вас есть 2 варианта:

  • Если ABC является объект или класс, который вы можете ссылаться на него, используя JSDoc имя_файлового_пространства (например: myNamespaceOrModule.ABC};
  • Если ABC не является реальным объектом JavaScript (например: а машинопись интерфейс), чем вы можете использовать JSDoc @typedef тег для документирования пользовательского тега.

Пожалуйста, укажите код, в котором класс ABC определен для лучшего ответа.