A doc comment standard for TypeScript
See the code
@param, @remarks, etc.| Folder | Version | Changelog | Description |
|---|---|---|---|
| /api-demo | (local project) | Code samples illustrating how to use the @microsoft/tsdoc parser | |
| /eslint-plugin |  | changelog | eslint-plugin-tsdoc plugin for ESLint |
| /playground | (local project) | Source code for the TSDoc Playground web app | |
| /tsdoc |  | changelog | @microsoft/tsdoc parser library |
| /tsdoc-config |  | changelog | @microsoft/tsdoc-config loader for tsdoc.json |
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Overall
Maintained
Code review
Latest release
Releases this year
(top 24 of 95)
6,582 followers · starred Jun 2023
163 followers · starred Jun 2023
1,937 followers · starred Oct 2020
2,130 followers · starred May 2018
A doc comment standard for TypeScript
See the code
@param, @remarks, etc.| Folder | Version | Changelog | Description |
|---|---|---|---|
| /api-demo | (local project) | Code samples illustrating how to use the @microsoft/tsdoc parser | |
| /eslint-plugin | | changelog | eslint-plugin-tsdoc plugin for ESLint |
| /playground | (local project) | Source code for the TSDoc Playground web app | |
| /tsdoc | | changelog | @microsoft/tsdoc parser library |
| /tsdoc-config | | changelog | @microsoft/tsdoc-config loader for tsdoc.json |
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Overall
Maintained
Code review
Latest release
Releases this year
(top 24 of 95)
6,582 followers · starred Jun 2023
163 followers · starred Jun 2023
1,937 followers · starred Oct 2020
2,130 followers · starred May 2018