TypeScript Docstrings

Features

This extension will save you time and make your code well-documented. Using this extension, you will be able to document your functions, classes, variables, header, etc, in the most efficient way. Look at the quick demo here:

Available Options

• Class
• Function
• Async function
• Author
• Constant variable
• Header
• Deprecated notation
• Generator function
• Global variable
• ReadOnly
• This keyword
• Todo
• DataTypes
• Object
• Getter
• Async static method
• Static method
• Method
• Setter
• Static getter
• Static setter
• Event
• Constructor
• Callback
• Typedef
• Namespace
• Mixin
• Throws
• Example
• See
• Description
• Param
• Returns
• Since
• Deprecated
• Enum
• Interface
• Private
• Public
• Package
• Throws
• Todo
• Example
• InheritDoc
• Template
• Variation
• Inheritdoc
• Override
• Tutorial
• Summary
• Default
• Suppress
• Experimental
• Ignore
• License
• Version
• Link

How It Works

Nothing special. Just install it and go to your Command Palette. There, search for JSDocs. Then, you will see a bunch of options like JSDocs: Function. Make sure your cursor or selection is on the line where you would like the documentation to be inserted on the line above that. That could be function's head in the case of function, just as demonstrated above.

Known Issues

Make sure your cursor is not on the first line, as the documentation is to be inserted on the line before that.

Release Notes

0.0.1

Initial release of Typescript-docstrings extension.

Quick Note

I am actively seeking a full-time position. Please let me know if you know of any at: faqima01@luther.edu. Thanks a lot!

Enjoy!

👨‍🚀 Author

👋 My Contacts:

Made with ❤️ by Estevam Souza

Contributors

Estevam Souza 💻