Влияет ли декоратор в комментариях на код? - PullRequest
2 голосов
/ 26 марта 2019

Я видел некоторый код, где декоратор находится в комментариях, эти комментарии выделены - см. Мой пример, полученный из этого кода , поэтому мне интересно, есть ли какой-либо эффект от этих строк кода. Вот пример:

/**
 * Instanciate a new Payment.
 * @param payplugApi Object  The PayplugAPI with sucessfull authentication
 * @param paymentTracker String  A payment tracker (id) that will be send and received by PayPlug API to follow the payment. This tracked will be inserted in metadata
 * @param payment   Object  The payment options. More informations here : https://www.payplug.com/docs/api/apiref.html?powershell#create-a-payment
 * @return [nothing]
 * @see PayPlugAPI.authenticate The authentication method
 */
var Payment = function () {...}

Это просто документация или выполнение кода?

Любая подсказка была бы отличной, спасибо!

1 Ответ

6 голосов
/ 26 марта 2019

Это комментарии JSDoc , которые анализируются в целях создания документации (и подсказок "hover" и т. Д. В IDE). Они не имеют отношения к декораторам.

...