{"id":13527615,"url":"https://github.com/joelday/vscode-docthis","last_synced_at":"2025-04-01T09:31:49.997Z","repository":{"id":78654449,"uuid":"51243524","full_name":"joelday/vscode-docthis","owner":"joelday","description":"JSDoc generator extension for Visual Studio Code.","archived":true,"fork":false,"pushed_at":"2020-07-20T15:47:20.000Z","size":400,"stargazers_count":294,"open_issues_count":71,"forks_count":74,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-11-02T12:35:02.368Z","etag":null,"topics":["docblock","javascript","jsdoc","typescript","visual-studio-code","visual-studio-code-extension"],"latest_commit_sha":null,"homepage":"https://goo.gl/HV3L4M","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joelday.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-07T10:21:57.000Z","updated_at":"2024-10-28T16:47:05.000Z","dependencies_parsed_at":"2023-03-06T09:00:14.809Z","dependency_job_id":null,"html_url":"https://github.com/joelday/vscode-docthis","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelday%2Fvscode-docthis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelday%2Fvscode-docthis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelday%2Fvscode-docthis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joelday%2Fvscode-docthis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joelday","download_url":"https://codeload.github.com/joelday/vscode-docthis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246616229,"owners_count":20806089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docblock","javascript","jsdoc","typescript","visual-studio-code","visual-studio-code-extension"],"created_at":"2024-08-01T06:01:54.020Z","updated_at":"2025-04-01T09:31:49.992Z","avatar_url":"https://github.com/joelday.png","language":"TypeScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026amp;business=7YU9WH4ANAB4Q\u0026amp;lc=US\u0026amp;item_name=Document%20This\u0026amp;item_number=vscode-docthis%20extension\u0026amp;currency_code=USD\u0026amp;bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted"],"categories":["TypeScript"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/joelday/vscode-docthis.svg?branch=master)](https://travis-ci.org/joelday/vscode-docthis) [![Paypal Donations](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026amp;business=7YU9WH4ANAB4Q\u0026amp;lc=US\u0026amp;item_name=Document%20This\u0026amp;item_number=vscode-docthis%20extension\u0026amp;currency_code=USD\u0026amp;bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted)\n\n# Document This\n\"Document This\" is a Visual Studio Code extension that automatically generates detailed JSDoc comments for both TypeScript and JavaScript files.\n\n![Demo](images/demo.gif)\n\n# Tags\nSupports JSDoc and Closure Compiler tags: @class, @description, @enum, @export, @function, @implements, @interface, @param, @private, @returns or @return, @static, @template, @type, @memberOf and @date.\n\n# Options\n#### docthis.includeTypes\nWhen enabled, type information is added to comment tags.\n\nDefault: true\n\n#### docthis.includeMemberOfOnClassMembers\nWhen enabled, memberOf information is added to comment tags on class members.\n\nDefault: true\n\n#### docthis.includeMemberOfOnInterfaceMembers\nWhen enabled, memberOf information is added to comment tags on interface members.\n\nDefault\": true\n\n#### docthis.includeDescriptionTag\nWhen enabled, JSDoc comments for functions and methods will include @description.\nDefault: false\n\n#### docthis.enableHungarianNotationEvaluation\nWhen enabled, hungarian notation will be used as a type hint.\n\nDefault: false\n\n#### docthis.inferTypesFromNames\nWhen enabled, will use names of params \u0026 methods as type hints.\n\nDefault: false\n\n#### docthis.includeAuthorTag\nWhen enabled, will add the @author tag.\n\nDefault: false\n\n#### docthis.authorName\nWhen docthis.includeAuthorTag is enabled, will add @author tag with this value.\n\nDefault: \"(Set the text for this tag by adding docthis.authorName to your settings file.)\"\n\n#### docthis.includeDateTag\nWhen enabled, will add the @date tag in YYYY-MM-DD format.\n\nDefault: false\n\n#### docthis.returnsTag\nPut @returns in place of @returns\n\nDefault: true\n\n# List of all available formats for @date tag\n\n| Format | Output           | Description                           |\n| ------ | ---------------- | ------------------------------------- |\n| `YY`   | 18               | Two-digit year                        |\n| `YYYY` | 2018             | Four-digit year                       |\n| `M`    | 1-12             | The month, beginning at 1             |\n| `MM`   | 01-12            | The month, 2-digits                   |\n| `MMM`  | Jan-Dec          | The abbreviated month name            |\n| `MMMM` | January-December | The full month name                   |\n| `D`    | 1-31             | The day of the month                  |\n| `DD`   | 01-31            | The day of the month, 2-digits        |\n| `d`    | 0-6              | The day of the week, with Sunday as 0 |\n| `dd`   | Su-Sa            | The min name of the day of the week   |\n| `ddd`  | Sun-Sat          | The short name of the day of the week |\n| `dddd` | Sunday-Saturday  | The name of the day of the week       |\n| `H`    | 0-23             | The hour                              |\n| `HH`   | 00-23            | The hour, 2-digits                    |\n| `h`    | 1-12             | The hour, 12-hour clock               |\n| `hh`   | 01-12            | The hour, 12-hour clock, 2-digits     |\n| `m`    | 0-59             | The minute                            |\n| `mm`   | 00-59            | The minute, 2-digits                  |\n| `s`    | 0-59             | The second                            |\n| `ss`   | 00-59            | The second, 2-digits                  |\n| `SSS`  | 000-999          | The millisecond, 3-digits             |\n| `Z`    | +5:00            | The offset from UTC                   |\n| `ZZ`   | +0500            | The offset from UTC, 2-digits         |\n| `A`    | AM PM            |                                       |\n| `a`    | am pm            |                                       |\n\n# Commands\n## Document This\n`Ctrl+Alt+D` and again `Ctrl+Alt+D`\n\nGenerates documentation for whatever the caret is on or inside of.\n\n## Trace TypeScript Syntax Node\nPrints info about the node ancestry at a given caret position.\n\n## Thank you for using Document This!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoelday%2Fvscode-docthis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoelday%2Fvscode-docthis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoelday%2Fvscode-docthis/lists"}