Quantcast
Channel: Node.js Tools for Visual Studio
Viewing all articles
Browse latest Browse all 4630

Commented Feature: Show jsdoc comments in signature tooltips [1283]

$
0
0
We should do the same thing as we do in PTVS, except that we should grab the nearby JSDoc (`/**`) comment instead of the docstring, and parse it using the JSDoc syntax. E.g. from azure module:
```js
* Creates a queue.
*
* @param {string} queuePath A string object that represents the name of the queue to delete.
* @param {object} [options] The request options.
* @param {int} [options.MaxSizeInMegaBytes] Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that will cause the queue to exceed this value will fail.
* @param {PTnHnMnS} [options.DefaultMessageTimeToLive] Depending on whether DeadLettering is enabled, a message is automatically moved to the DeadLetterQueue or deleted if it has been stored in the queue for longer than the specified time. This value is overwritten by a TTL specified on the message if and only if the message TTL is smaller than the TTL set on the queue. This value is immutable after the Queue has been created.
* @param {PTnHnMnS} [options.LockDuration] Determines the amount of time in seconds in which a message should be locked for processing by a receiver. After this period, the message is unlocked and available for consumption by the next receiver. Settable only at queue creation time.
* @param {bool} [options.RequiresSession] Settable only at queue creation time. If set to true, the queue will be session-aware and only SessionReceiver will be supported. Session-aware queues are not supported through REST.
* @param {bool} [options.RequiresDuplicateDetection] Settable only at queue creation time.
* @param {bool} [options.DeadLetteringOnMessageExpiration] This field controls how the Service Bus handles a message whose TTL has expired. If it is enabled and a message expires, the Service Bus moves the message from the queue into the queue’s dead-letter sub-queue. If disabled, message will be permanently deleted from the queue. Settable only at queue creation time.
* @param {bool} [options.DuplicateDetectionHistoryTimeWindow] Specifies the time span during which the Service Bus detects message duplication.
* @param {Function(error, createqueueresult, response)} callback `error` will contain information
* if an error occurs; otherwise `createqueueresult` will contain
* the new queue information.
* `response` will contain information related to this operation.
* @return {undefined}
*/
ServiceBusService.prototype.createQueue = function (queuePath, optionsOrCallback, callback)
```

Comments: +1 JSDoc awareness would be quite valuable.

Viewing all articles
Browse latest Browse all 4630

Trending Articles



<script src="https://jsc.adskeeper.com/r/s/rssing.com.1596347.js" async> </script>