{"id":13560480,"url":"https://github.com/aaron-bond/better-comments","last_synced_at":"2025-05-16T14:08:49.357Z","repository":{"id":39747832,"uuid":"87725807","full_name":"aaron-bond/better-comments","owner":"aaron-bond","description":null,"archived":false,"fork":false,"pushed_at":"2023-04-28T03:14:12.000Z","size":448,"stargazers_count":873,"open_issues_count":313,"forks_count":171,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-12T12:53:52.628Z","etag":null,"topics":["formatting","typescript","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments","language":"TypeScript","has_issues":true,"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/aaron-bond.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":"aaron-bond"}},"created_at":"2017-04-09T17:21:58.000Z","updated_at":"2025-04-05T13:50:44.000Z","dependencies_parsed_at":"2024-01-14T02:44:04.021Z","dependency_job_id":"7c4b6185-57f1-4803-85c1-1561ba39f052","html_url":"https://github.com/aaron-bond/better-comments","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/aaron-bond%2Fbetter-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaron-bond%2Fbetter-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaron-bond%2Fbetter-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aaron-bond%2Fbetter-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aaron-bond","download_url":"https://codeload.github.com/aaron-bond/better-comments/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["formatting","typescript","vscode-extension"],"created_at":"2024-08-01T13:00:44.892Z","updated_at":"2025-05-16T14:08:44.342Z","avatar_url":"https://github.com/aaron-bond.png","language":"TypeScript","funding_links":["https://github.com/sponsors/aaron-bond"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Better Comments\n\nThe Better Comments extension will help you create more human-friendly comments in your code.  \nWith this extension, you will be able to categorise your annotations into:\n* Alerts\n* Queries\n* TODOs\n* Highlights\n* Commented out code can also be styled to make it clear the code shouldn't be there\n* Any other comment styles you'd like can be specified in the settings\n\n![Annotated code](images/better-comments.PNG)\n\n## Configuration\n\nThis extension can be configured in User Settings or Workspace settings.\n\n`\"better-comments.multilineComments\": true`  \n This setting will control whether multiline comments are styled using the annotation tags.\n When false, multiline comments will be presented without decoration.\n\n`\"better-comments.highlightPlainText\": false`  \nThis setting will control whether comments in a plain text file are styled using the annotation tags.\nWhen true, the tags (defaults: `! * ? //`) will be detected if they're the first character on a line.\n\n`better-comments.tags`  \nThe tags are the characters or sequences used to mark a comment for decoration.\nThe default 5 can be modified to change the colors, and more can be added.\n\n```json\n\"better-comments.tags\": [\n  {\n    \"tag\": \"!\",\n    \"color\": \"#FF2D00\",\n    \"strikethrough\": false,\n    \"underline\": false,\n    \"backgroundColor\": \"transparent\",\n    \"bold\": false,\n    \"italic\": false\n  },\n  {\n    \"tag\": \"?\",\n    \"color\": \"#3498DB\",\n    \"strikethrough\": false,\n    \"underline\": false,\n    \"backgroundColor\": \"transparent\",\n    \"bold\": false,\n    \"italic\": false\n  },\n  {\n    \"tag\": \"//\",\n    \"color\": \"#474747\",\n    \"strikethrough\": true,\n    \"underline\": false,\n    \"backgroundColor\": \"transparent\",\n    \"bold\": false,\n    \"italic\": false\n  },\n  {\n    \"tag\": \"todo\",\n    \"color\": \"#FF8C00\",\n    \"strikethrough\": false,\n    \"underline\": false,\n    \"backgroundColor\": \"transparent\",\n    \"bold\": false,\n    \"italic\": false\n  },\n  {\n    \"tag\": \"*\",\n    \"color\": \"#98C379\",\n    \"strikethrough\": false,\n    \"underline\": false,\n    \"backgroundColor\": \"transparent\",\n    \"bold\": false,\n    \"italic\": false\n  }\n]\n```\n\n## Supported Languages\n\n* Ada\n* AL\n* Apex\n* AsciiDoc\n* BrightScript\n* C\n* C#\n* C++\n* ColdFusion\n* Clojure\n* COBOL\n* CoffeeScript\n* CSS\n* Dart\n* Dockerfile\n* Elixir\n* Elm\n* Erlang\n* F#\n* Fortran\n* gdscript\n* GenStat\n* Go\n* GraphQL\n* Groovy\n* Haskell\n* Haxe\n* HiveQL\n* HTML\n* Java\n* JavaScript\n* JavaScript React\n* JSON with comments\n* Julia\n* Kotlin\n* LaTex (inlc. Bibtex/Biblatex)\n* Less\n* Lisp\n* Lua\n* Makefile\n* Markdown\n* Nim\n* MATLAB\n* Objective-C\n* Objective-C++\n* Pascal\n* Perl\n* Perl 6\n* PHP\n* Pig\n* PlantUML\n* PL/SQL\n* PowerShell\n* Puppet\n* Python\n* R\n* Racket\n* Ruby\n* Rust\n* SAS\n* Sass\n* Scala\n* SCSS\n* ShaderLab\n* ShellScript\n* SQL\n* STATA\n* Stylus\n* Svelte\n* Swift\n* Tcl\n* Terraform\n* Twig\n* TypeScript\n* TypeScript React\n* Verilog\n* Visual Basic\n* Vue.js\n* XML\n* YAML\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaron-bond%2Fbetter-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faaron-bond%2Fbetter-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faaron-bond%2Fbetter-comments/lists"}